From 9dcd62c731e3b3dbe43900708b380f7eb4cf9a50 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 20 Oct 2023 14:01:27 +0300 Subject: [PATCH] chore(docs): Generated JS Client Reference (#5421) * chore(docs): Generated JS Client Reference (automated) * fix js client reference * fix links --------- Co-authored-by: olivermrbl Co-authored-by: Shahed nasser --- .../packages/typedoc-config/js-client.js | 20 +- .../package.json | 3 +- .../src/resources/helpers/comment-tag.ts | 13 + .../src/resources/helpers/comment.ts | 1 + .../src/resources/helpers/comments.ts | 7 +- .../src/utils/reflection-formatter.ts | 2 +- docs-util/yarn.lock | 1 - www/apps/docs/content/js-client/overview.md | 4 +- .../discounts/admin/manage-discounts.mdx | 4 +- ...counts.internal.EventEmitter.Abortable.mdx | 22 + .../classes/addresses.AddressesResource.mdx | 176 + .../addresses/modules/addresses.internal.mdx | 43 + .../js-client/admin/classes/admin.Admin.mdx | 318 + .../classes/admin_auth.AdminAuthResource.mdx | 205 + .../modules/admin_auth.internal.mdx | 163 + ...dmin_batch_jobs.AdminBatchJobsResource.mdx | 264 + .../modules/admin_batch_jobs.internal.mdx | 181 + ...n_collections.AdminCollectionsResource.mdx | 418 + .../modules/admin_collections.internal.mdx | 261 + ...min_currencies.AdminCurrenciesResource.mdx | 131 + .../modules/admin_currencies.internal.mdx | 74 + .../admin_custom.AdminCustomResource.mdx | 224 + .../modules/admin_custom.internal.mdx | 11 + ...mer_groups.AdminCustomerGroupsResource.mdx | 473 + .../admin_customer_groups.internal.mdx | 81 + ...admin_customers.AdminCustomersResource.mdx | 229 + .../modules/admin_customers.internal.mdx | 48 + ...admin_discounts.AdminDiscountsResource.mdx | 1033 ++ .../modules/admin_discounts.internal.mdx | 14357 ++++++++++++++++ ..._draft_orders.AdminDraftOrdersResource.mdx | 544 + ...dmin_gift_cards.AdminGiftCardsResource.mdx | 292 + ...ntory_item.AdminInventoryItemsResource.mdx | 636 + .../admin_invites.AdminInvitesResource.mdx | 229 + .../modules/admin_invites.internal.mdx | 19 + .../admin_notes.AdminNotesResource.mdx | 272 + ...tifications.AdminNotificationsResource.mdx | 119 + ...in_order_edits.AdminOrderEditsResource.mdx | 677 + .../admin_orders.AdminOrdersResource.mdx | 1500 ++ ...ctions.AdminPaymentCollectionsResource.mdx | 229 + .../admin_payments.AdminPaymentsResource.mdx | 178 + ...min_price_lists.AdminPriceListResource.mdx | 626 + ...egories.AdminProductCategoriesResource.mdx | 446 + ..._product_tags.AdminProductTagsResource.mdx | 52 + ...roduct_types.AdminProductTypesResource.mdx | 60 + .../admin_products.AdminProductsResource.mdx | 791 + ...pi_keys.AdminPublishableApiKeyResource.mdx | 508 + .../admin_regions.AdminRegionsResource.mdx | 725 + ...reservations.AdminReservationsResource.mdx | 312 + ...urn_reasons.AdminReturnReasonsResource.mdx | 284 + .../admin_returns.AdminReturnsResource.mdx | 182 + ...es_channels.AdminSalesChannelsResource.mdx | 572 + ...g_options.AdminShippingOptionsResource.mdx | 292 + ...profiles.AdminShippingProfilesResource.mdx | 264 + ..._locations.AdminStockLocationsResource.mdx | 312 + .../admin_store.AdminStoresResource.mdx | 315 + .../admin_swaps.AdminSwapsResource.mdx | 111 + .../admin_tax_rates.AdminTaxRatesResource.mdx | 698 + .../admin_uploads.AdminUploadsResource.mdx | 251 + .../modules/admin_uploads.internal.mdx | 769 + .../admin_users.AdminUsersResource.mdx | 383 + .../modules/admin_users.internal.mdx | 62 + .../admin_variants.AdminVariantsResource.mdx | 174 + .../auth/classes/auth.AuthResource.mdx | 260 + .../carts/classes/carts.CartsResource.mdx | 676 + .../js-client/classes/AddressesResource.md | 81 - .../references/js-client/classes/Admin.md | 391 - .../js-client/classes/AdminAuthResource.md | 110 - .../classes/AdminBatchJobsResource.md | 116 - .../classes/AdminCollectionsResource.md | 199 - .../classes/AdminCurrenciesResource.md | 70 - .../js-client/classes/AdminCustomResource.md | 99 - .../classes/AdminCustomerGroupsResource.md | 200 - .../classes/AdminCustomersResource.md | 104 - .../classes/AdminDiscountsResource.md | 429 - .../classes/AdminDraftOrdersResource.md | 241 - .../classes/AdminGiftCardsResource.md | 137 - .../classes/AdminInventoryItemsResource.md | 302 - .../js-client/classes/AdminInvitesResource.md | 115 - .../js-client/classes/AdminNotesResource.md | 117 - .../classes/AdminNotificationsResource.md | 54 - .../classes/AdminOrderEditsResource.md | 270 - .../js-client/classes/AdminOrdersResource.md | 563 - .../AdminPaymentCollectionsResource.md | 97 - .../classes/AdminPaymentsResource.md | 76 - .../classes/AdminPriceListResource.md | 249 - .../classes/AdminProductCategoriesResource.md | 222 - .../classes/AdminProductTagsResource.md | 31 - .../classes/AdminProductTypesResource.md | 32 - .../classes/AdminProductsResource.md | 317 - .../classes/AdminPublishableApiKeyResource.md | 205 - .../js-client/classes/AdminRegionsResource.md | 342 - .../classes/AdminReservationsResource.md | 167 - .../classes/AdminReturnReasonsResource.md | 146 - .../js-client/classes/AdminReturnsResource.md | 93 - .../classes/AdminSalesChannelsResource.md | 285 - .../classes/AdminShippingOptionsResource.md | 147 - .../classes/AdminShippingProfilesResource.md | 116 - .../classes/AdminStockLocationsResource.md | 165 - .../js-client/classes/AdminStoresResource.md | 170 - .../js-client/classes/AdminSwapsResource.md | 53 - .../classes/AdminTaxRatesResource.md | 258 - .../js-client/classes/AdminUploadsResource.md | 141 - .../js-client/classes/AdminUsersResource.md | 194 - .../classes/AdminVariantsResource.md | 83 - .../js-client/classes/AuthResource.md | 135 - .../js-client/classes/CartsResource.md | 289 - .../js-client/classes/CollectionsResource.md | 61 - .../js-client/classes/CustomerResource.md | 169 - .../js-client/classes/GiftCardsResource.md | 36 - .../js-client/classes/LineItemsResource.md | 85 - .../js-client/classes/OrderEditsResource.md | 75 - .../js-client/classes/OrdersResource.md | 136 - .../classes/PaymentCollectionsResource.md | 143 - .../classes/PaymentMethodsResource.md | 33 - .../classes/ProductCategoriesResource.md | 62 - .../js-client/classes/ProductTagsResource.md | 36 - .../js-client/classes/ProductTypesResource.md | 36 - .../classes/ProductVariantsResource.md | 61 - .../js-client/classes/ProductsResource.md | 96 - .../js-client/classes/RegionsResource.md | 60 - .../classes/ReturnReasonsResource.md | 58 - .../js-client/classes/ReturnsResource.md | 34 - .../classes/ShippingOptionsResource.md | 61 - .../js-client/classes/SwapsResource.md | 61 - .../classes/internal-1.AdminPostAuthReq.md | 44 - .../classes/internal-1.BaseEntity.md | 75 - .../classes/internal-1.SoftDeletableEntity.md | 147 - .../js-client/classes/internal-1.User.md | 151 - .../js-client/classes/internal-12.Axios.md | 294 - .../js-client/classes/internal-12.Client.md | 186 - ...nternal-2.AdminGetBatchPaginationParams.md | 63 - .../classes/internal-2.AdminGetBatchParams.md | 173 - .../js-client/classes/internal-2.BatchJob.md | 239 - .../internal-2.DateComparisonOperator.md | 47 - .../js-client/classes/internal-3.Address.md | 221 - ...-3.AdminDeleteProductsFromCollectionReq.md | 31 - ...l-3.AdminGetCollectionsPaginationParams.md | 33 - .../internal-3.AdminGetCollectionsParams.md | 111 - ...nal-3.AdminPostCollectionsCollectionReq.md | 55 - .../internal-3.AdminPostCollectionsReq.md | 57 - ...rnal-3.AdminPostProductsToCollectionReq.md | 31 - .../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 - .../js-client/classes/internal-3.Country.md | 87 - .../js-client/classes/internal-3.Currency.md | 57 - .../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 - .../classes/internal-3.FulfillmentProvider.md | 27 - .../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 - .../js-client/classes/internal-3.OrderEdit.md | 341 - .../classes/internal-3.OrderItemChange.md | 151 - .../js-client/classes/internal-3.Payment.md | 227 - .../classes/internal-3.PaymentCollection.md | 211 - .../classes/internal-3.PaymentProvider.md | 27 - .../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 - .../classes/internal-3.TaxProvider.md | 27 - .../js-client/classes/internal-3.TaxRate.md | 187 - .../classes/internal-3.TrackingLink.md | 141 - .../internal-4.AdminGetCurrenciesParams.md | 71 - ...ternal-4.AdminPostCurrenciesCurrencyReq.md | 27 - .../internal-4.FindPaginationParams.md | 39 - ...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 - .../internal-6.CustomerGroupsBatchCustomer.md | 17 - ...internal-6.FilterableCustomerGroupProps.md | 73 - .../classes/internal-6.FindParams.md | 145 - .../internal-6.StringComparisonOperator.md | 77 - .../internal-7.AdminGetCustomersParams.md | 85 - .../internal-7.AdminListCustomerSelector.md | 43 - ...nternal-7.AdminPostCustomersCustomerReq.md | 117 - .../internal-7.AdminPostCustomersReq.md | 101 - .../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 - ...countsDiscountConditionsConditionParams.md | 41 - ...l-8.AdminGetDiscountsDiscountRuleParams.md | 27 - .../internal-8.AdminGetDiscountsParams.md | 109 - .../internal-8.AdminListOrdersSelector.md | 173 - ...-8.AdminPostDiscountsDiscountConditions.md | 131 - ...ostDiscountsDiscountConditionsCondition.md | 114 - ...sDiscountConditionsConditionBatchParams.md | 41 - ...untsDiscountConditionsConditionBatchReq.md | 36 - ...countsDiscountConditionsConditionParams.md | 41 - ...inPostDiscountsDiscountConditionsParams.md | 41 - ...minPostDiscountsDiscountDynamicCodesReq.md | 58 - ...nternal-8.AdminPostDiscountsDiscountReq.md | 195 - ...ternal-8.AdminPostDiscountsDiscountRule.md | 57 - .../internal-8.AdminPostDiscountsReq.md | 214 - .../internal-8.AdminPriceSelectionParams.md | 95 - ...nternal-8.AdminProductCategoriesReqBase.md | 65 - .../internal-8.AdminUpdateDiscountRule.md | 57 - .../internal-8.AdminUpsertCondition.md | 103 - .../internal-8.AdminUpsertConditionsReq.md | 69 - .../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 | 17 - .../classes/internal-8.Discount-2.md | 17 - .../classes/internal-8.Discount-3.md | 17 - .../js-client/classes/internal-8.Discount.md | 17 - .../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 - .../internal-8.FilterableProductProps.md | 195 - ...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 | 57 - .../classes/internal-8.MedusaError.md | 205 - .../internal-8.NotificationProvider.md | 27 - .../classes/internal-8.OptionRequirement-1.md | 37 - .../classes/internal-8.OptionRequirement.md | 27 - .../classes/internal-8.OrdersReturnItem.md | 47 - .../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 - ...nternal-8.ProductVariantPricesCreateReq.md | 57 - ...nternal-8.ProductVariantPricesUpdateReq.md | 67 - .../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 | 37 - .../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 - ...minGetPriceListsPriceListProductsParams.md | 209 - ...nternal.AdminGetProductCategoriesParams.md | 129 - ....internal.AdminGetProductCategoryParams.md | 41 - ...nal.AdminGetProductTagsPaginationParams.md | 33 - ...al-8.internal.AdminGetProductTagsParams.md | 111 - ...l-8.internal.AdminGetProductTypesParams.md | 111 - ...ernal-8.internal.AdminGetProductsParams.md | 317 - ...internal.AdminGetProductsVariantsParams.md | 47 - ...nternal.AdminGetRegionsPaginationParams.md | 33 - ...ternal-8.internal.AdminGetRegionsParams.md | 71 - ...l-8.internal.AdminGetReservationsParams.md | 139 - ...ternal-8.internal.AdminGetReturnsParams.md | 27 - ...-8.internal.AdminGetSalesChannelsParams.md | 149 - ....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 - ...rnal.AdminPostOrdersOrderShipmentParams.md | 41 - ...nternal.AdminPostOrdersOrderShipmentReq.md | 56 - ...minPostOrdersOrderShippingMethodsParams.md | 41 - ....AdminPostOrdersOrderShippingMethodsReq.md | 55 - ...rdersOrderSwapFulfillementsCancelParams.md | 41 - ...nternal.AdminPostOrdersOrderSwapsParams.md | 41 - ...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 - ...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 | 67 - ....internal.AdminPriceListPricesUpdateReq.md | 77 - .../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 - ...nal-8.internal.FilterablePriceListProps.md | 113 - .../internal-8.internal.FulfillmentOption.md | 27 - ...l-8.internal.FulfillmentProviderService.md | 459 - ...8.internal.GetOrderEditsOrderEditParams.md | 41 - ...internal-8.internal.GetOrderEditsParams.md | 89 - .../internal-8.internal.GetPaymentsParams.md | 41 - ...GetPublishableApiKeySalesChannelsParams.md | 79 - ...-8.internal.GetPublishableApiKeysParams.md | 79 - .../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 - ...al-8.internal.StoreGetCollectionsParams.md | 57 - ...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 - ...l-8.internal.StoreGetProductTypesParams.md | 111 - ...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 - .../classes/internal.AddressCreatePayload.md | 176 - .../classes/internal.AddressPayload.md | 175 - ...ostCustomersCustomerAddressesAddressReq.md | 173 - ....StorePostCustomersCustomerAddressesReq.md | 28 - .../collections.CollectionsResource.mdx | 119 + .../classes/customers.CustomerResource.mdx | 332 + .../js-client/enums/internal-1.UserRoles.md | 37 - .../enums/internal-2.BatchJobStatus.md | 77 - .../enums/internal-3.AllocationType.md | 27 - .../js-client/enums/internal-3.CartType.md | 57 - .../internal-3.ClaimFulfillmentStatus.md | 97 - .../enums/internal-3.ClaimPaymentStatus.md | 37 - .../js-client/enums/internal-3.ClaimReason.md | 47 - .../js-client/enums/internal-3.ClaimType.md | 27 - .../internal-3.DiscountConditionOperator.md | 27 - .../enums/internal-3.DiscountConditionType.md | 57 - .../enums/internal-3.DiscountRuleType.md | 37 - .../enums/internal-3.DraftOrderStatus.md | 27 - .../internal-3.OrderEditItemChangeType.md | 37 - .../enums/internal-3.OrderEditStatus.md | 57 - .../js-client/enums/internal-3.OrderStatus.md | 57 - .../internal-3.PaymentCollectionStatus.md | 57 - .../enums/internal-3.PriceListStatus.md | 27 - .../enums/internal-3.PriceListType.md | 27 - .../enums/internal-3.ProductStatus.md | 47 - .../enums/internal-3.RequirementType.md | 27 - .../enums/internal-3.ReturnStatus.md | 47 - .../internal-3.ShippingOptionPriceType.md | 27 - .../enums/internal-3.ShippingProfileType.md | 37 - .../enums/internal-8.DefaultPriceType.md | 13 - ...-8.DiscountConditionJoinTableForeignKey.md | 57 - .../enums/internal-8.MODULE_RESOURCE_TYPE.md | 27 - .../js-client/enums/internal-8.OrderStatus.md | 57 - ...ternal-8.internal.PaymentCollectionType.md | 13 - ...nternal-8.internal.PaymentSessionStatus.md | 57 - .../internal-8.internal.PostgresError.md | 47 - .../enums/internal-8.internal.RefundReason.md | 57 - .../classes/gift_cards.GiftCardsResource.mdx | 64 + .../content/references/js-client/index.md | 139 +- .../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 - .../internal-12.AxiosBasicCredentials.md | 27 - .../interfaces/internal-12.AxiosDefaults.md | 521 - .../interfaces/internal-12.AxiosError.md | 130 - .../interfaces/internal-12.AxiosInstance.md | 377 - .../internal-12.AxiosInterceptorManager.md | 60 - .../interfaces/internal-12.AxiosPromise.md | 132 - .../internal-12.AxiosProxyConfig.md | 54 - .../internal-12.AxiosRequestTransformer.md | 28 - .../interfaces/internal-12.AxiosResponse.md | 74 - .../internal-12.AxiosResponseTransformer.md | 28 - .../interfaces/internal-12.Cancel.md | 17 - .../interfaces/internal-12.CancelToken.md | 41 - .../interfaces/internal-12.Config.md | 57 - .../interfaces/internal-12.HTTPResponse.md | 57 - .../interfaces/internal-12.HeadersDefaults.md | 117 - .../interfaces/internal-12.RetryConfig.md | 195 - .../internal-12.TransitionalOptions.md | 37 - .../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 - .../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 - ...discounts.internal.internal-2.Writable.mdx | 4258 +++++ ...ts.internal.internal-2.FinishedOptions.mdx | 46 + ...min_discounts.internal.internal-2.Pipe.mdx | 93 + ...ts.internal.internal-2.PipelineOptions.mdx | 30 + ...ts.internal.internal-2.ReadableOptions.mdx | 204 + ...unts.internal.internal-2.StreamOptions.mdx | 159 + ...ts.internal.internal-2.WritableOptions.mdx | 320 + ...discounts.internal.internal-2.finished.mdx | 51 + ...discounts.internal.internal-2.pipeline.mdx | 582 + ...ddresses.internal.AddressCreatePayload.mdx | 106 + .../addresses.internal.AddressPayload.mdx | 106 + ...stCustomersCustomerAddressesAddressReq.mdx | 108 + ...StorePostCustomersCustomerAddressesReq.mdx | 26 + .../admin_auth.internal.AdminPostAuthReq.mdx | 47 + .../admin_auth.internal.BaseEntity.mdx | 40 + ...dmin_auth.internal.SoftDeletableEntity.mdx | 48 + .../classes/admin_auth.internal.User.mdx | 112 + ...internal.AdminGetBatchPaginationParams.mdx | 54 + ...atch_jobs.internal.AdminGetBatchParams.mdx | 126 + ...tch_jobs.internal.AdminPostBatchesReq.mdx} | 61 +- .../admin_batch_jobs.internal.BatchJob.mdx | 202 + ...h_jobs.internal.DateComparisonOperator.mdx | 46 + .../admin_collections.internal.Address.mdx | 168 + ...l.AdminDeleteProductsFromCollectionReq.mdx | 26 + ...al.AdminGetCollectionsPaginationParams.mdx | 30 + ...ons.internal.AdminGetCollectionsParams.mdx | 86 + ...rnal.AdminPostCollectionsCollectionReq.mdx | 42 + ...tions.internal.AdminPostCollectionsReq.mdx | 42 + ...ernal.AdminPostProductsToCollectionReq.mdx | 26 + .../admin_collections.internal.Cart.mdx | 368 + .../admin_collections.internal.ClaimImage.mdx | 88 + .../admin_collections.internal.ClaimItem.mdx | 152 + .../admin_collections.internal.ClaimOrder.mdx | 192 + .../admin_collections.internal.ClaimTag.mdx | 72 + .../admin_collections.internal.Country.mdx | 78 + .../admin_collections.internal.Currency.mdx | 54 + .../admin_collections.internal.Customer.mdx | 152 + ...min_collections.internal.CustomerGroup.mdx | 88 + .../admin_collections.internal.Discount.mdx | 168 + ...collections.internal.DiscountCondition.mdx | 136 + ...dmin_collections.internal.DiscountRule.mdx | 104 + .../admin_collections.internal.DraftOrder.mdx | 136 + ...admin_collections.internal.Fulfillment.mdx | 192 + ...n_collections.internal.FulfillmentItem.mdx | 54 + ...llections.internal.FulfillmentProvider.mdx | 30 + .../admin_collections.internal.GiftCard.mdx | 144 + ...llections.internal.GiftCardTransaction.mdx | 94 + .../admin_collections.internal.Image.mdx | 72 + .../admin_collections.internal.LineItem.mdx | 410 + ...ollections.internal.LineItemAdjustment.mdx | 86 + ...n_collections.internal.LineItemTaxLine.mdx | 96 + ...admin_collections.internal.MoneyAmount.mdx | 168 + .../admin_collections.internal.Order.mdx | 464 + .../admin_collections.internal.OrderEdit.mdx | 277 + ...n_collections.internal.OrderItemChange.mdx | 112 + .../admin_collections.internal.Payment.mdx | 176 + ...collections.internal.PaymentCollection.mdx | 160 + ...n_collections.internal.PaymentProvider.mdx | 30 + ...in_collections.internal.PaymentSession.mdx | 128 + .../admin_collections.internal.PriceList.mdx | 128 + .../admin_collections.internal.Product.mdx | 320 + ...n_collections.internal.ProductCategory.mdx | 144 + ...collections.internal.ProductCollection.mdx | 88 + ...min_collections.internal.ProductOption.mdx | 96 + ...ollections.internal.ProductOptionValue.mdx | 104 + .../admin_collections.internal.ProductTag.mdx | 72 + ...admin_collections.internal.ProductType.mdx | 72 + ...in_collections.internal.ProductVariant.mdx | 248 + ...s.internal.ProductVariantInventoryItem.mdx | 88 + .../admin_collections.internal.Refund.mdx | 120 + .../admin_collections.internal.Region.mdx | 176 + .../admin_collections.internal.Return.mdx | 176 + .../admin_collections.internal.ReturnItem.mdx | 110 + ...dmin_collections.internal.ReturnReason.mdx | 112 + ...dmin_collections.internal.SalesChannel.mdx | 96 + ...lections.internal.SalesChannelLocation.mdx | 80 + ...in_collections.internal.ShippingMethod.mdx | 182 + ...ections.internal.ShippingMethodTaxLine.mdx | 96 + ...in_collections.internal.ShippingOption.mdx | 176 + ...ons.internal.ShippingOptionRequirement.mdx | 70 + ...n_collections.internal.ShippingProfile.mdx | 96 + .../admin_collections.internal.Swap.mdx | 216 + .../admin_collections.internal.TaxLine.mdx | 72 + ...admin_collections.internal.TaxProvider.mdx | 30 + .../admin_collections.internal.TaxRate.mdx | 144 + ...dmin_collections.internal.TrackingLink.mdx | 104 + ...cies.internal.AdminGetCurrenciesParams.mdx | 54 + ...nternal.AdminPostCurrenciesCurrencyReq.mdx | 26 + ...rrencies.internal.FindPaginationParams.mdx | 30 + ...eteCustomerGroupsGroupCustomerBatchReq.mdx | 26 + ...rnal.AdminGetCustomerGroupsGroupParams.mdx | 30 + ....internal.AdminGetCustomerGroupsParams.mdx | 94 + ...stCustomerGroupsGroupCustomersBatchReq.mdx | 26 + ...ternal.AdminPostCustomerGroupsGroupReq.mdx | 34 + ...ps.internal.AdminPostCustomerGroupsReq.mdx | 34 + ...s.internal.CustomerGroupsBatchCustomer.mdx | 22 + ....internal.FilterableCustomerGroupProps.mdx | 62 + ...in_customer_groups.internal.FindParams.mdx | 30 + ...oups.internal.StringComparisonOperator.mdx | 70 + ...omers.internal.AdminGetCustomersParams.mdx | 62 + ...ers.internal.AdminListCustomerSelector.mdx | 38 + ...internal.AdminPostCustomersCustomerReq.mdx | 74 + ...stomers.internal.AdminPostCustomersReq.mdx | 66 + .../admin_customers.internal.Group.mdx | 22 + ...internal.AbstractEventBusModuleService.mdx | 349 + ...scounts.internal.AbstractSearchService.mdx | 468 + ...in_discounts.internal.AdditionalItem-1.mdx | 30 + ...in_discounts.internal.AdditionalItem-2.mdx | 30 + ...dmin_discounts.internal.AdditionalItem.mdx | 30 + ...iscounts.internal.AdminCreateCondition.mdx | 62 + ...ntsDiscountConditionsConditionBatchReq.mdx | 41 + ...ountsDiscountConditionsConditionParams.mdx | 30 + ...al.AdminGetDiscountsDiscountRuleParams.mdx | 30 + ...ounts.internal.AdminGetDiscountsParams.mdx | 78 + ...ounts.internal.AdminListOrdersSelector.mdx | 142 + ...l.AdminPostDiscountsDiscountConditions.mdx | 100 + ...stDiscountsDiscountConditionsCondition.mdx | 85 + ...DiscountConditionsConditionBatchParams.mdx | 30 + ...ntsDiscountConditionsConditionBatchReq.mdx | 41 + ...ountsDiscountConditionsConditionParams.mdx | 30 + ...nPostDiscountsDiscountConditionsParams.mdx | 30 + ...inPostDiscountsDiscountDynamicCodesReq.mdx | 42 + ...internal.AdminPostDiscountsDiscountReq.mdx | 124 + ...nternal.AdminPostDiscountsDiscountRule.mdx | 54 + ...scounts.internal.AdminPostDiscountsReq.mdx | 140 + ...nts.internal.AdminPriceSelectionParams.mdx | 62 + ...internal.AdminProductCategoriesReqBase.mdx | 54 + ...ounts.internal.AdminUpdateDiscountRule.mdx | 54 + ...iscounts.internal.AdminUpsertCondition.mdx | 70 + ...unts.internal.AdminUpsertConditionsReq.mdx | 54 + .../classes/admin_discounts.internal.Blob.mdx | 195 + ...iscounts.internal.CustomShippingOption.mdx | 30 + ...min_discounts.internal.CustomerGroup-1.mdx | 22 + ...admin_discounts.internal.CustomerGroup.mdx | 22 + ...discounts.internal.CustomerGroupUpdate.mdx | 30 + .../admin_discounts.internal.Discount-1.mdx | 22 + .../admin_discounts.internal.Discount-2.mdx | 22 + .../admin_discounts.internal.Discount-3.mdx | 22 + .../admin_discounts.internal.Discount.mdx | 22 + .../admin_discounts.internal.Duplex.mdx | 6973 ++++++++ ...dmin_discounts.internal.EventEmitter-1.mdx | 1560 ++ ...discounts.internal.FilterableCartProps.mdx | 38 + ...ounts.internal.FilterableDiscountProps.mdx | 54 + ...rnal.FilterableLineItemAdjustmentProps.mdx | 62 + ...counts.internal.FilterableProductProps.mdx | 160 + ...internal.FilterableProductVariantProps.mdx | 182 + .../admin_discounts.internal.FlagRouter.mdx | 145 + ..._discounts.internal.FulfillmentService.mdx | 693 + .../admin_discounts.internal.GiftCard-1.mdx | 22 + .../admin_discounts.internal.GiftCard.mdx | 22 + .../admin_discounts.internal.Image.mdx | 30 + .../admin_discounts.internal.Item-1.mdx | 62 + .../admin_discounts.internal.Item-2.mdx | 30 + .../admin_discounts.internal.Item-3.mdx | 62 + .../admin_discounts.internal.Item-4.mdx | 30 + .../admin_discounts.internal.Item-5.mdx | 46 + .../admin_discounts.internal.Item-6.mdx | 46 + .../classes/admin_discounts.internal.Item.mdx | 54 + .../admin_discounts.internal.MedusaError.mdx | 240 + ...iscounts.internal.NotificationProvider.mdx | 30 + ...discounts.internal.OptionRequirement-1.mdx | 38 + ...n_discounts.internal.OptionRequirement.mdx | 30 + ...in_discounts.internal.OrdersReturnItem.mdx | 46 + .../admin_discounts.internal.PassThrough.mdx | 6676 +++++++ ...admin_discounts.internal.PaymentMethod.mdx | 30 + ...dmin_discounts.internal.PaymentService.mdx | 593 + ...iscounts.internal.PriceSelectionParams.mdx | 54 + ...s.internal.ProductBatchProductCategory.mdx | 22 + ...unts.internal.ProductBatchSalesChannel.mdx | 22 + ...in_discounts.internal.ProductOptionReq.mdx | 22 + ...nts.internal.ProductProductCategoryReq.mdx | 22 + ...counts.internal.ProductSalesChannelReq.mdx | 22 + ...admin_discounts.internal.ProductTagReq.mdx | 30 + ...dmin_discounts.internal.ProductTypeReq.mdx | 30 + ...nts.internal.ProductVariantOptionReq-1.mdx | 30 + ...nts.internal.ProductVariantOptionReq-2.mdx | 22 + ...nts.internal.ProductVariantOptionReq-3.mdx | 30 + ...ounts.internal.ProductVariantOptionReq.mdx | 30 + ...internal.ProductVariantPricesCreateReq.mdx | 54 + ...internal.ProductVariantPricesUpdateReq.mdx | 62 + ...discounts.internal.ProductVariantReq-1.mdx | 174 + ...n_discounts.internal.ProductVariantReq.mdx | 166 + .../admin_discounts.internal.Readable.mdx | 4721 +++++ .../admin_discounts.internal.ReadableBase.mdx | 4871 ++++++ .../admin_discounts.internal.ReturnItem.mdx | 46 + ...in_discounts.internal.ReturnShipping-1.mdx | 30 + ...in_discounts.internal.ReturnShipping-2.mdx | 30 + ...in_discounts.internal.ReturnShipping-3.mdx | 22 + ...dmin_discounts.internal.ReturnShipping.mdx | 30 + ...in_discounts.internal.ShippingMethod-1.mdx | 46 + ...in_discounts.internal.ShippingMethod-2.mdx | 46 + ...in_discounts.internal.ShippingMethod-3.mdx | 54 + ...dmin_discounts.internal.ShippingMethod.mdx | 38 + ...counts.internal.StockLocationAddress-1.mdx | 78 + ...iscounts.internal.StockLocationAddress.mdx | 82 + .../admin_discounts.internal.Stream.mdx | 1620 ++ .../classes/admin_discounts.internal.Tag.mdx | 30 + .../admin_discounts.internal.Transform.mdx | 6678 +++++++ .../admin_discounts.internal.WritableBase.mdx | 4372 +++++ .../admin_discounts.internal.internal-5.mdx | 1616 ++ ...rnal.internal.AbstractBatchJobStrategy.mdx | 561 + ...nternal.AbstractCartCompletionStrategy.mdx | 302 + ....internal.internal.AbstractFileService.mdx | 537 + ...al.internal.AbstractFulfillmentService.mdx | 765 + ...l.internal.AbstractNotificationService.mdx | 407 + ...rnal.internal.AbstractPaymentProcessor.mdx | 617 + ...ternal.internal.AbstractPaymentService.mdx | 1069 ++ ...nternal.AbstractPriceSelectionStrategy.mdx | 355 + ...s.internal.internal.AbstractTaxService.mdx | 125 + ...ternal.internal.AdminCreateUserRequest.mdx | 58 + ...DiscountConditionsConditionBatchParams.mdx | 30 + ...ountsDiscountConditionsConditionParams.mdx | 30 + ...al.AdminDeletePriceListPricesPricesReq.mdx | 33 + ...ceListsPriceListProductsPricesBatchReq.mdx | 33 + ...tCategoriesCategoryProductsBatchParams.mdx | 30 + ...ductCategoriesCategoryProductsBatchReq.mdx | 41 + ...PublishableApiKeySalesChannelsBatchReq.mdx | 41 + ...teSalesChannelsChannelProductsBatchReq.mdx | 41 + ...eSalesChannelsChannelStockLocationsReq.mdx | 33 + ...eleteTaxRatesTaxRateProductTypesParams.mdx | 30 + ...inDeleteTaxRatesTaxRateProductTypesReq.mdx | 26 + ...minDeleteTaxRatesTaxRateProductsParams.mdx | 30 + ....AdminDeleteTaxRatesTaxRateProductsReq.mdx | 26 + ...teTaxRatesTaxRateShippingOptionsParams.mdx | 30 + ...eleteTaxRatesTaxRateShippingOptionsReq.mdx | 26 + ...nternal.internal.AdminDeleteUploadsReq.mdx | 26 + ...ternal.internal.AdminGetDiscountParams.mdx | 30 + ...al.AdminGetDiscountsDiscountCodeParams.mdx | 30 + ...nal.internal.AdminGetDraftOrdersParams.mdx | 38 + ...ernal.internal.AdminGetGiftCardsParams.mdx | 38 + ...InventoryItemsItemLocationLevelsParams.mdx | 38 + ...ernal.AdminGetInventoryItemsItemParams.mdx | 30 + ....internal.AdminGetInventoryItemsParams.mdx | 150 + ....internal.internal.AdminGetNotesParams.mdx | 38 + ...l.internal.AdminGetNotificationsParams.mdx | 86 + ...nal.internal.AdminGetOrdersOrderParams.mdx | 30 + ...internal.internal.AdminGetOrdersParams.mdx | 174 + ...ernal.AdminGetPaymentCollectionsParams.mdx | 30 + ...rnal.AdminGetPriceListPaginationParams.mdx | 126 + ...inGetPriceListsPriceListProductsParams.mdx | 158 + ...ternal.AdminGetProductCategoriesParams.mdx | 94 + ...internal.AdminGetProductCategoryParams.mdx | 30 + ...al.AdminGetProductTagsPaginationParams.mdx | 30 + ...nal.internal.AdminGetProductTagsParams.mdx | 86 + ...al.internal.AdminGetProductTypesParams.mdx | 86 + ...ternal.internal.AdminGetProductsParams.mdx | 200 + ...nternal.AdminGetProductsVariantsParams.mdx | 46 + ...ternal.AdminGetRegionsPaginationParams.mdx | 30 + ...nternal.internal.AdminGetRegionsParams.mdx | 54 + ...GetRegionsRegionFulfillmentOptionsRes.mdx} | 25 +- ...al.internal.AdminGetReservationsParams.mdx | 102 + ...nternal.internal.AdminGetReturnsParams.mdx | 30 + ...l.internal.AdminGetSalesChannelsParams.mdx | 110 + ...internal.AdminGetShippingOptionsParams.mdx | 38 + ...l.AdminGetStockLocationsLocationParams.mdx | 30 + ....internal.AdminGetStockLocationsParams.mdx | 78 + ....internal.internal.AdminGetSwapsParams.mdx | 30 + ...ternal.internal.AdminGetTaxRatesParams.mdx | 78 + ...internal.AdminGetTaxRatesTaxRateParams.mdx | 30 + ...nternal.internal.AdminGetVariantParams.mdx | 30 + ...ternal.internal.AdminGetVariantsParams.mdx | 110 + ...nPostAnalyticsConfigAnalyticsConfigReq.mdx | 30 + ...l.internal.AdminPostAnalyticsConfigReq.mdx | 30 + ...ernal.AdminPostDiscountsDiscountParams.mdx | 30 + ...rnal.internal.AdminPostDiscountsParams.mdx | 30 + ...tDraftOrdersDraftOrderLineItemsItemReq.mdx | 57 + ...nPostDraftOrdersDraftOrderLineItemsReq.mdx | 70 + ...rnal.AdminPostDraftOrdersDraftOrderReq.mdx | 82 + ...ernal.internal.AdminPostDraftOrdersReq.mdx | 120 + ...internal.AdminPostGiftCardsGiftCardReq.mdx | 66 + ...nternal.internal.AdminPostGiftCardsReq.mdx | 68 + ...nPostInventoryItemsInventoryItemParams.mdx | 30 + ...dminPostInventoryItemsInventoryItemReq.mdx | 151 + ...toryItemsItemLocationLevelsLevelParams.mdx | 30 + ...ventoryItemsItemLocationLevelsLevelReq.mdx | 42 + ...InventoryItemsItemLocationLevelsParams.mdx | 30 + ...ostInventoryItemsItemLocationLevelsReq.mdx | 56 + ...internal.AdminPostInventoryItemsParams.mdx | 30 + ...al.internal.AdminPostInventoryItemsReq.mdx | 130 + ...ternal.AdminPostInvitesInviteAcceptReq.mdx | 34 + ...al.AdminPostInvitesInviteAcceptUserReq.mdx | 38 + ....internal.internal.AdminPostInvitesReq.mdx | 34 + ...nternal.internal.AdminPostNotesNoteReq.mdx | 33 + ...ts.internal.internal.AdminPostNotesReq.mdx | 57 + ...PostNotificationsNotificationResendReq.mdx | 31 + ...PostOrderEditsEditLineItemsLineItemReq.mdx | 33 + ...al.AdminPostOrderEditsEditLineItemsReq.mdx | 42 + ...ternal.AdminPostOrderEditsOrderEditReq.mdx | 31 + ...ternal.internal.AdminPostOrderEditsReq.mdx | 52 + ...inPostOrderEditsRequestConfirmationReq.mdx | 22 + ...al.internal.AdminPostOrdersClaimCancel.mdx | 30 + ...ostOrdersClaimFulfillmentsCancelParams.mdx | 30 + ...rnal.AdminPostOrdersOrderArchiveParams.mdx | 30 + ...al.internal.AdminPostOrdersOrderCancel.mdx | 30 + ...rnal.AdminPostOrdersOrderCaptureParams.mdx | 30 + ...dersOrderClaimsClaimFulfillmentsParams.mdx | 30 + ...tOrdersOrderClaimsClaimFulfillmentsReq.mdx | 43 + ....AdminPostOrdersOrderClaimsClaimParams.mdx | 30 + ...nal.AdminPostOrdersOrderClaimsClaimReq.mdx | 50 + ...tOrdersOrderClaimsClaimShipmentsParams.mdx | 30 + ...PostOrdersOrderClaimsClaimShipmentsReq.mdx | 46 + ...ernal.AdminPostOrdersOrderClaimsParams.mdx | 30 + ...internal.AdminPostOrdersOrderClaimsReq.mdx | 171 + ...nal.AdminPostOrdersOrderCompleteParams.mdx | 30 + ...stOrdersOrderFulfillementsCancelParams.mdx | 30 + ...AdminPostOrdersOrderFulfillmentsParams.mdx | 30 + ...al.AdminPostOrdersOrderFulfillmentsReq.mdx | 71 + ...al.internal.AdminPostOrdersOrderParams.mdx | 30 + ...rnal.AdminPostOrdersOrderRefundsParams.mdx | 30 + ...nternal.AdminPostOrdersOrderRefundsReq.mdx | 67 + ...ernal.internal.AdminPostOrdersOrderReq.mdx | 159 + ...rnal.AdminPostOrdersOrderReturnsParams.mdx | 30 + ...ternal.AdminPostOrdersOrderReturnsReq.mdx} | 133 +- ...nal.AdminPostOrdersOrderShipmentParams.mdx | 30 + ...ternal.AdminPostOrdersOrderShipmentReq.mdx | 57 + ...inPostOrdersOrderShippingMethodsParams.mdx | 30 + ...AdminPostOrdersOrderShippingMethodsReq.mdx | 56 + ...dersOrderSwapFulfillementsCancelParams.mdx | 30 + ...ternal.AdminPostOrdersOrderSwapsParams.mdx | 30 + ...internal.AdminPostOrdersOrderSwapsReq.mdx} | 151 +- ...OrdersOrderSwapsSwapFulfillmentsParams.mdx | 30 + ...ostOrdersOrderSwapsSwapFulfillmentsReq.mdx | 43 + ...dersOrderSwapsSwapProcessPaymentParams.mdx | 30 + ...ostOrdersOrderSwapsSwapShipmentsParams.mdx | 30 + ...inPostOrdersOrderSwapsSwapShipmentsReq.mdx | 57 + ...ternal.AdminPostOrdersSwapCancelParams.mdx | 30 + ...al.internal.AdminPostPaymentRefundsReq.mdx | 56 + ...nal.AdminPostPriceListPricesPricesReq.mdx} | 43 +- ...minPostPriceListsPriceListPriceListReq.mdx | 111 + ...ternal.AdminPostPriceListsPriceListReq.mdx | 108 + ...minPostProductCategoriesCategoryParams.mdx | 30 + ...tCategoriesCategoryProductsBatchParams.mdx | 30 + ...ductCategoriesCategoryProductsBatchReq.mdx | 41 + ....AdminPostProductCategoriesCategoryReq.mdx | 97 + ...ernal.AdminPostProductCategoriesParams.mdx | 30 + ...internal.AdminPostProductCategoriesReq.mdx | 88 + ...al.AdminPostProductsProductMetadataReq.mdx | 45 + ....AdminPostProductsProductOptionsOption.mdx | 26 + ...nal.AdminPostProductsProductOptionsReq.mdx | 26 + ...l.internal.AdminPostProductsProductReq.mdx | 235 + ...al.AdminPostProductsProductVariantsReq.mdx | 201 + ...nPostProductsProductVariantsVariantReq.mdx | 201 + ...internal.internal.AdminPostProductsReq.mdx | 297 + ...PublishableApiKeySalesChannelsBatchReq.mdx | 41 + ...PublishableApiKeysPublishableApiKeyReq.mdx | 31 + ...nternal.AdminPostPublishableApiKeysReq.mdx | 33 + ...nal.AdminPostRegionsRegionCountriesReq.mdx | 26 + ...stRegionsRegionFulfillmentProvidersReq.mdx | 26 + ...inPostRegionsRegionPaymentProvidersReq.mdx | 26 + ...nal.internal.AdminPostRegionsRegionReq.mdx | 120 + ....internal.internal.AdminPostRegionsReq.mdx | 90 + ...rnal.internal.AdminPostReservationsReq.mdx | 66 + ...al.AdminPostReservationsReservationReq.mdx | 50 + ...ternal.AdminPostReturnReasonsReasonReq.mdx | 50 + ...nal.internal.AdminPostReturnReasonsReq.mdx | 58 + ...ernal.AdminPostReturnsReturnReceiveReq.mdx | 64 + ...stSalesChannelsChannelProductsBatchReq.mdx | 41 + ...tSalesChannelsChannelStockLocationsReq.mdx | 33 + ...nal.internal.AdminPostSalesChannelsReq.mdx | 55 + ....AdminPostSalesChannelsSalesChannelReq.mdx | 53 + ...rnal.AdminPostShippingOptionsOptionReq.mdx | 69 + ...l.internal.AdminPostShippingOptionsReq.mdx | 120 + ...al.AdminPostShippingProfilesProfileReq.mdx | 58 + ....internal.AdminPostShippingProfilesReq.mdx | 54 + ....AdminPostStockLocationsLocationParams.mdx | 30 + ...nal.AdminPostStockLocationsLocationReq.mdx | 50 + ...internal.AdminPostStockLocationsParams.mdx | 30 + ...al.internal.AdminPostStockLocationsReq.mdx | 60 + ...ts.internal.internal.AdminPostStoreReq.mdx | 82 + ...ernal.internal.AdminPostTaxRatesParams.mdx | 30 + ...internal.internal.AdminPostTaxRatesReq.mdx | 74 + ...nternal.AdminPostTaxRatesTaxRateParams.mdx | 30 + ...nPostTaxRatesTaxRateProductTypesParams.mdx | 30 + ...dminPostTaxRatesTaxRateProductTypesReq.mdx | 26 + ...AdminPostTaxRatesTaxRateProductsParams.mdx | 30 + ...al.AdminPostTaxRatesTaxRateProductsReq.mdx | 26 + ...l.internal.AdminPostTaxRatesTaxRateReq.mdx | 74 + ...stTaxRatesTaxRateShippingOptionsParams.mdx | 30 + ...nPostTaxRatesTaxRateShippingOptionsReq.mdx | 26 + ...nternal.AdminPostUploadsDownloadUrlReq.mdx | 26 + ...internal.AdminPriceListPricesCreateReq.mdx | 62 + ...internal.AdminPriceListPricesUpdateReq.mdx | 70 + ...unts.internal.internal.AdminRegionsRes.mdx | 26 + ...nal.internal.AdminResetPasswordRequest.mdx | 42 + ...nternal.AdminResetPasswordTokenRequest.mdx | 26 + ...ernal.AdminUpdatePaymentCollectionsReq.mdx | 34 + ...ternal.internal.AdminUpdateUserRequest.mdx | 58 + ...unts.internal.internal.AnalyticsConfig.mdx | 80 + ...ternal.internal.AnalyticsConfigService.mdx | 433 + ...iscounts.internal.internal.AuthService.mdx | 456 + ...unts.internal.internal.BatchJobService.mdx | 908 + ...iscounts.internal.internal.CartService.mdx | 2573 +++ ...nts.internal.internal.ClaimItemService.mdx | 511 + ...scounts.internal.internal.ClaimService.mdx | 1006 ++ ...unts.internal.internal.CurrencyService.mdx | 432 + ...internal.internal.CustomShippingOption.mdx | 104 + ...l.internal.CustomShippingOptionService.mdx | 410 + ...internal.internal.CustomerGroupService.mdx | 670 + ...unts.internal.internal.CustomerService.mdx | 1208 ++ ...nternal.DiscountConditionCustomerGroup.mdx | 70 + ...rnal.internal.DiscountConditionProduct.mdx | 70 + ...nal.DiscountConditionProductCollection.mdx | 70 + ...l.internal.DiscountConditionProductTag.mdx | 70 + ....internal.DiscountConditionProductType.mdx | 70 + ...rnal.internal.DiscountConditionService.mdx | 474 + ...unts.internal.internal.DiscountService.mdx | 1419 ++ ...ts.internal.internal.DraftOrderService.mdx | 765 + ...nts.internal.internal.EmptyQueryParams.mdx | 9 + ...unts.internal.internal.EventBusService.mdx | 641 + ...ernal.internal.FilterableBatchJobProps.mdx | 62 + ...rnal.internal.FilterablePriceListProps.mdx | 94 + ...ts.internal.internal.FulfillmentOption.mdx | 30 + ...al.internal.FulfillmentProviderService.mdx | 878 + ....internal.GetOrderEditsOrderEditParams.mdx | 30 + ....internal.internal.GetOrderEditsParams.mdx | 62 + ...ts.internal.internal.GetPaymentsParams.mdx | 30 + ...etPublishableApiKeySalesChannelsParams.mdx | 54 + ...l.internal.GetPublishableApiKeysParams.mdx | 54 + ...unts.internal.internal.GiftCardService.mdx | 810 + ...rnal.internal.IAdminPostUploadsFileReq.mdx | 30 + ...ounts.internal.internal.IdempotencyKey.mdx | 102 + ...nternal.internal.IdempotencyKeyService.mdx | 556 + ...min_discounts.internal.internal.Invite.mdx | 104 + ...admin_discounts.internal.internal.Item.mdx | 30 + ...nal.internal.LineItemAdjustmentService.mdx | 684 + ...unts.internal.internal.LineItemService.mdx | 1081 ++ ...ts.internal.internal.MiddlewareService.mdx | 420 + ...nts.internal.internal.NewTotalsService.mdx | 1128 ++ ...admin_discounts.internal.internal.Note.mdx | 104 + ...iscounts.internal.internal.NoteService.mdx | 606 + ...scounts.internal.internal.Notification.mdx | 144 + ....internal.internal.NotificationService.mdx | 781 + ...l.internal.NumericalComparisonOperator.mdx | 46 + ...dmin_discounts.internal.internal.Oauth.mdx | 70 + ...scounts.internal.internal.OauthService.mdx | 657 + ...al.internal.OrderEditItemChangeService.mdx | 476 + ...nts.internal.internal.OrderEditService.mdx | 1300 ++ ...scounts.internal.internal.OrderService.mdx | 2186 +++ ...rnal.internal.PaymentCollectionService.mdx | 797 + ...ternal.internal.PaymentProviderService.mdx | 1654 ++ ...nts.internal.internal.PriceListService.mdx | 1159 ++ ...ounts.internal.internal.PricingService.mdx | 923 + ...ternal.internal.ProductCategoryService.mdx | 953 + ...rnal.internal.ProductCollectionService.mdx | 778 + ...ounts.internal.internal.ProductService.mdx | 1563 ++ ...ounts.internal.internal.ProductTaxRate.mdx | 70 + ...s.internal.internal.ProductTypeService.mdx | 417 + ...s.internal.internal.ProductTypeTaxRate.mdx | 70 + ...nternal.ProductVariantInventoryService.mdx | 1240 ++ ...nal.internal.ProductVariantMoneyAmount.mdx | 72 + ...nternal.internal.ProductVariantService.mdx | 1534 ++ ...ts.internal.internal.PublishableApiKey.mdx | 80 + ...internal.PublishableApiKeySalesChannel.mdx | 30 + ...counts.internal.internal.RegionService.mdx | 1290 ++ ....internal.internal.ReturnReasonService.mdx | 481 + ...counts.internal.internal.ReturnService.mdx | 1011 ++ ....internal.SalesChannelInventoryService.mdx | 309 + ...l.internal.SalesChannelLocationService.mdx | 454 + ....internal.internal.SalesChannelService.mdx | 861 + ...counts.internal.internal.SearchService.mdx | 481 + ...ternal.internal.ShippingAddressPayload.mdx | 22 + ...nternal.internal.ShippingOptionService.mdx | 1170 ++ ...ternal.internal.ShippingProfileService.mdx | 1088 ++ ...unts.internal.internal.ShippingTaxRate.mdx | 70 + ..._discounts.internal.internal.StagedJob.mdx | 54 + ...nts.internal.internal.StagedJobService.mdx | 380 + ...dmin_discounts.internal.internal.Store.mdx | 136 + ...nal.internal.StoreGetCollectionsParams.mdx | 54 + ...ustomersCustomerOrdersPaginationParams.mdx | 46 + ....StoreGetCustomersCustomerOrdersParams.mdx | 158 + ...internal.internal.StoreGetOrdersParams.mdx | 54 + ...ernal.StoreGetPaymentCollectionsParams.mdx | 30 + ...toreGetProductCategoriesCategoryParams.mdx | 30 + ...ternal.StoreGetProductCategoriesParams.mdx | 78 + ...nal.internal.StoreGetProductTagsParams.mdx | 86 + ...al.internal.StoreGetProductTypesParams.mdx | 86 + ...ernal.StoreGetProductsPaginationParams.mdx | 78 + ...ternal.internal.StoreGetProductsParams.mdx | 190 + ...nternal.internal.StoreGetRegionsParams.mdx | 46 + ...internal.StoreGetShippingOptionsParams.mdx | 38 + ...ternal.internal.StoreGetVariantsParams.mdx | 110 + ...internal.StoreGetVariantsVariantParams.mdx | 62 + ...rnal.StorePaymentCollectionSessionsReq.mdx | 33 + ...nts.internal.internal.StorePostAuthReq.mdx | 45 + ...nts.internal.internal.StorePostCartReq.mdx | 62 + ...nal.StorePostCartsCartLineItemsItemReq.mdx | 34 + ...nternal.StorePostCartsCartLineItemsReq.mdx | 42 + ...al.StorePostCartsCartPaymentSessionReq.mdx | 33 + ...rePostCartsCartPaymentSessionUpdateReq.mdx | 33 + ...nternal.internal.StorePostCartsCartReq.mdx | 102 + ...al.StorePostCartsCartShippingMethodReq.mdx | 44 + ...orePostCustomersCustomerAcceptClaimReq.mdx | 26 + ...torePostCustomersCustomerOrderClaimReq.mdx | 26 + ...ePostCustomersCustomerPasswordTokenReq.mdx | 26 + ...internal.StorePostCustomersCustomerReq.mdx | 74 + ...nternal.internal.StorePostCustomersReq.mdx | 58 + ...nal.StorePostCustomersResetPasswordReq.mdx | 42 + ...al.StorePostOrderEditsOrderEditDecline.mdx | 31 + ...ntCollectionsBatchSessionsAuthorizeReq.mdx | 26 + ...PostPaymentCollectionsBatchSessionsReq.mdx | 26 + ...StorePostPaymentCollectionsSessionsReq.mdx | 38 + ....internal.internal.StorePostReturnsReq.mdx | 42 + ...s.internal.internal.StorePostSearchReq.mdx | 63 + ...ts.internal.internal.StorePostSwapsReq.mdx | 50 + ...scounts.internal.internal.StoreService.mdx | 513 + ...ernal.internal.StrategyResolverService.mdx | 274 + ...iscounts.internal.internal.SwapService.mdx | 1381 ++ ....internal.SystemPaymentProviderService.mdx | 823 + ...s.internal.internal.TaxProviderService.mdx | 917 + ...ounts.internal.internal.TaxRateService.mdx | 995 ++ ...scounts.internal.internal.TokenService.mdx | 114 + ...counts.internal.internal.TotalsService.mdx | 1488 ++ ...ternal.internal.TransactionBaseService.mdx | 216 + ...iscounts.internal.internal.UserService.mdx | 820 + .../internal/classes/swaps.internal.Axios.mdx | 648 + .../classes/swaps.internal.Client.mdx | 383 + .../enums/admin_auth.internal.UserRoles.mdx | 27 + ...min_batch_jobs.internal.BatchJobStatus.mdx | 51 + ...in_collections.internal.AllocationType.mdx | 21 + .../admin_collections.internal.CartType.mdx | 39 + ...tions.internal.ClaimFulfillmentStatus.mdx} | 42 +- ...ollections.internal.ClaimPaymentStatus.mdx | 27 + ...admin_collections.internal.ClaimReason.mdx | 33 + .../admin_collections.internal.ClaimType.mdx | 21 + ...ons.internal.DiscountConditionOperator.mdx | 21 + ...ections.internal.DiscountConditionType.mdx | 39 + ..._collections.internal.DiscountRuleType.mdx | 27 + ..._collections.internal.DraftOrderStatus.mdx | 21 + ...ollections.internal.FulfillmentStatus.mdx} | 40 +- ...tions.internal.OrderEditItemChangeType.mdx | 27 + ...n_collections.internal.OrderEditStatus.mdx | 39 + ...admin_collections.internal.OrderStatus.mdx | 39 + ...tions.internal.PaymentCollectionStatus.mdx | 39 + ...in_collections.internal.PaymentStatus.mdx} | 34 +- ...n_collections.internal.PriceListStatus.mdx | 21 + ...min_collections.internal.PriceListType.mdx | 21 + ...min_collections.internal.ProductStatus.mdx | 33 + ...n_collections.internal.RequirementType.mdx | 21 + ...dmin_collections.internal.ReturnStatus.mdx | 33 + ...tions.internal.ShippingOptionPriceType.mdx | 21 + ...llections.internal.ShippingProfileType.mdx | 27 + ...ections.internal.SwapFulfillmentStatus.mdx | 45 + ...ollections.internal.SwapPaymentStatus.mdx} | 42 +- ...in_discounts.internal.DefaultPriceType.mdx | 15 + ...l.DiscountConditionJoinTableForeignKey.mdx | 39 + ..._discounts.internal.FulfillmentStatus.mdx} | 42 +- ...iscounts.internal.MODULE_RESOURCE_TYPE.mdx | 21 + .../admin_discounts.internal.OrderStatus.mdx | 39 + ...dmin_discounts.internal.PaymentStatus.mdx} | 34 +- ...nternal.internal.PaymentCollectionType.mdx | 15 + ...internal.internal.PaymentSessionStatus.mdx | 39 + ...counts.internal.internal.PostgresError.mdx | 33 + ...scounts.internal.internal.RefundReason.mdx | 39 + .../admin_collections.internal.Boolean.mdx | 32 + .../admin_custom.internal.RequestOptions.mdx | 30 + ...min_discounts.internal.ArrayBufferView.mdx | 38 + .../admin_discounts.internal.ArrayLike.mdx | 39 + ...dmin_discounts.internal.AsyncGenerator.mdx | 200 + ...counts.internal.AsyncGeneratorFunction.mdx | 99 + ...admin_discounts.internal.AsyncIterable.mdx | 60 + ...scounts.internal.AsyncIterableIterator.mdx | 211 + ...admin_discounts.internal.AsyncIterator.mdx | 167 + .../admin_discounts.internal.BlobOptions.mdx | 30 + .../admin_discounts.internal.Buffer.mdx | 5989 +++++++ ...n_discounts.internal.BufferConstructor.mdx | 866 + .../admin_discounts.internal.CallSite.mdx | 315 + ...min_discounts.internal.CreateNoteInput.mdx | 62 + ...min_discounts.internal.CreateUserInput.mdx | 70 + ...admin_discounts.internal.DuplexOptions.mdx | 434 + ...dmin_discounts.internal.ErrnoException.mdx | 70 + .../admin_discounts.internal.Error.mdx | 38 + ...min_discounts.internal.EventEmitter-2.mdx} | 564 +- ...discounts.internal.EventEmitterOptions.mdx | 22 + .../admin_discounts.internal.FindConfig.mdx | 78 + ...admin_discounts.internal.ICacheService.mdx | 147 + ...counts.internal.IEventBusModuleService.mdx | 215 + ...in_discounts.internal.IEventBusService.mdx | 221 + .../admin_discounts.internal.IFlagRouter.mdx | 34 + ...n_discounts.internal.IInventoryService.mdx | 1549 ++ ...dmin_discounts.internal.ISearchService.mdx | 386 + ...scounts.internal.IStockLocationService.mdx | 376 + ...ounts.internal.ITransactionBaseService.mdx | 43 + .../admin_discounts.internal.Iterable.mdx | 60 + ...in_discounts.internal.IterableIterator.mdx | 184 + .../admin_discounts.internal.Iterator.mdx | 140 + ...iscounts.internal.IteratorReturnResult.mdx | 43 + ...discounts.internal.IteratorYieldResult.mdx | 43 + ...discounts.internal.JoinerServiceConfig.mdx | 70 + ...unts.internal.JoinerServiceConfigAlias.mdx | 30 + .../admin_discounts.internal.Logger.mdx | 118 + ...s.internal.NumericalComparisonOperator.mdx | 46 + .../admin_discounts.internal.Object.mdx | 199 + .../admin_discounts.internal.PromiseLike.mdx | 94 + ...min_discounts.internal.QueuingStrategy.mdx | 43 + ...discounts.internal.QueuingStrategySize.mdx | 56 + ...min_discounts.internal.ReadWriteStream.mdx | 1579 ++ ....internal.ReadableByteStreamController.mdx | 119 + ...l.ReadableByteStreamControllerCallback.mdx | 43 + ...in_discounts.internal.ReadableStream-1.mdx | 288 + ...dmin_discounts.internal.ReadableStream.mdx | 1309 ++ ...ternal.ReadableStreamDefaultController.mdx | 124 + ...al.ReadableStreamDefaultReadDoneResult.mdx | 30 + ...l.ReadableStreamDefaultReadValueResult.mdx | 43 + ...s.internal.ReadableStreamDefaultReader.mdx | 124 + ...s.internal.ReadableStreamErrorCallback.mdx | 43 + ...s.internal.ReadableStreamGenericReader.mdx | 56 + ...iscounts.internal.ReadableWritablePair.mdx | 51 + ...n_discounts.internal.SharedArrayBuffer.mdx | 82 + ....internal.SharedArrayBufferConstructor.mdx | 22 + ...nts.internal.StaticEventEmitterOptions.mdx | 22 + ...n_discounts.internal.StreamPipeOptions.mdx | 46 + ...unts.internal.StringComparisonOperator.mdx | 70 + ...in_discounts.internal.TransformOptions.mdx | 534 + ...iscounts.internal.UnderlyingByteSource.mdx | 54 + ...dmin_discounts.internal.UnderlyingSink.mdx | 67 + ...s.internal.UnderlyingSinkAbortCallback.mdx | 43 + ...s.internal.UnderlyingSinkCloseCallback.mdx | 30 + ...s.internal.UnderlyingSinkStartCallback.mdx | 43 + ...s.internal.UnderlyingSinkWriteCallback.mdx | 64 + ...in_discounts.internal.UnderlyingSource.mdx | 59 + ...nternal.UnderlyingSourceCancelCallback.mdx | 43 + ....internal.UnderlyingSourcePullCallback.mdx | 56 + ...internal.UnderlyingSourceStartCallback.mdx | 56 + ...min_discounts.internal.UpdateUserInput.mdx | 70 + ...in_discounts.internal.WritableStream-1.mdx | 115 + ...dmin_discounts.internal.WritableStream.mdx | 1192 ++ ...ternal.WritableStreamDefaultController.mdx | 48 + ...s.internal.WritableStreamDefaultWriter.mdx | 166 + ...min_discounts.internal._DOMEventTarget.mdx | 67 + ...in_discounts.internal._NodeEventTarget.mdx | 51 + ...ts.internal.internal.CustomFindOptions.mdx | 75 + ...discounts.internal.internal.FindConfig.mdx | 67 + ...s.internal.internal.FulfillmentService.mdx | 684 + ...ts.internal.internal.IBatchJobStrategy.mdx | 393 + ...ernal.internal.ICartCompletionStrategy.mdx | 75 + ...scounts.internal.internal.IFileService.mdx | 497 + ...internal.internal.INotificationService.mdx | 354 + ...ernal.internal.IPriceSelectionStrategy.mdx | 158 + ...ernal.internal.ITaxCalculationStrategy.mdx | 71 + ...iscounts.internal.internal.ITaxService.mdx | 87 + ...nts.internal.internal.PaymentProcessor.mdx | 545 + ...nternal.internal.PaymentProcessorError.mdx | 38 + ...ounts.internal.internal.PaymentService.mdx | 1007 ++ ...admin_uploads.internal.BlobPropertyBag.mdx | 30 + .../admin_uploads.internal.File.mdx | 221 + ...admin_uploads.internal.FilePropertyBag.mdx | 38 + ...admin_uploads.internal.QueuingStrategy.mdx | 43 + ...n_uploads.internal.QueuingStrategySize.mdx | 56 + ....internal.ReadableByteStreamController.mdx | 127 + .../admin_uploads.internal.ReadableStream.mdx | 305 + ...oads.internal.ReadableStreamBYOBReader.mdx | 143 + ...ads.internal.ReadableStreamBYOBRequest.mdx | 96 + ...ternal.ReadableStreamDefaultController.mdx | 132 + ...s.internal.ReadableStreamDefaultReader.mdx | 132 + ...s.internal.ReadableStreamGenericReader.mdx | 58 + ...nternal.ReadableStreamGetReaderOptions.mdx | 22 + ....internal.ReadableStreamReadDoneResult.mdx | 43 + ...internal.ReadableStreamReadValueResult.mdx | 43 + ..._uploads.internal.ReadableWritablePair.mdx | 51 + ...min_uploads.internal.StreamPipeOptions.mdx | 46 + ..._uploads.internal.UnderlyingByteSource.mdx | 54 + ...loads.internal.UnderlyingDefaultSource.mdx | 59 + .../admin_uploads.internal.UnderlyingSink.mdx | 67 + ...s.internal.UnderlyingSinkAbortCallback.mdx | 43 + ...s.internal.UnderlyingSinkCloseCallback.mdx | 30 + ...s.internal.UnderlyingSinkStartCallback.mdx | 43 + ...s.internal.UnderlyingSinkWriteCallback.mdx | 64 + ...dmin_uploads.internal.UnderlyingSource.mdx | 67 + ...nternal.UnderlyingSourceCancelCallback.mdx | 43 + ....internal.UnderlyingSourcePullCallback.mdx | 56 + ...internal.UnderlyingSourceStartCallback.mdx | 56 + .../admin_uploads.internal.WritableStream.mdx | 121 + ...ternal.WritableStreamDefaultController.mdx | 62 + ...s.internal.WritableStreamDefaultWriter.mdx | 173 + .../swaps.internal.AxiosAdapter.mdx | 52 + .../swaps.internal.AxiosBasicCredentials.mdx | 30 + .../swaps.internal.AxiosDefaults.mdx | 293 + .../interfaces/swaps.internal.AxiosError.mdx | 107 + .../swaps.internal.AxiosInstance.mdx | 776 + ...swaps.internal.AxiosInterceptorManager.mdx | 109 + .../swaps.internal.AxiosPromise.mdx | 230 + .../swaps.internal.AxiosProxyConfig.mdx | 62 + ...swaps.internal.AxiosRequestTransformer.mdx | 51 + .../swaps.internal.AxiosResponse.mdx | 83 + ...waps.internal.AxiosResponseTransformer.mdx | 51 + .../interfaces/swaps.internal.Cancel.mdx | 22 + .../interfaces/swaps.internal.CancelToken.mdx | 51 + .../interfaces/swaps.internal.Config.mdx | 54 + .../swaps.internal.HTTPResponse.mdx | 54 + .../swaps.internal.HeadersDefaults.mdx | 102 + .../interfaces/swaps.internal.RetryConfig.mdx | 120 + .../swaps.internal.TransitionalOptions.mdx | 38 + .../admin_discounts.internal.EventEmitter.mdx | 19 + .../admin_discounts.internal.internal-1.mdx | 645 + .../admin_discounts.internal.internal-2.mdx | 1743 ++ .../admin_discounts.internal.internal-3.mdx | 624 + .../admin_discounts.internal.internal-4.mdx | 255 + .../admin_discounts.internal.internal.mdx | 10468 +++++++++++ .../classes/line_items.LineItemsResource.mdx | 201 + .../js-client/modules/addresses.mdx | 15 + .../references/js-client/modules/admin.mdx | 227 + .../js-client/modules/admin_auth.mdx | 15 + .../js-client/modules/admin_batch_jobs.mdx | 15 + .../js-client/modules/admin_collections.mdx | 15 + .../js-client/modules/admin_currencies.mdx | 15 + .../js-client/modules/admin_custom.mdx | 15 + .../modules/admin_customer_groups.mdx | 15 + .../js-client/modules/admin_customers.mdx | 15 + .../js-client/modules/admin_discounts.mdx | 15 + .../js-client/modules/admin_draft_orders.mdx | 11 + .../js-client/modules/admin_gift_cards.mdx | 11 + .../modules/admin_inventory_item.mdx | 11 + .../js-client/modules/admin_invites.mdx | 15 + .../js-client/modules/admin_notes.mdx | 11 + .../js-client/modules/admin_notifications.mdx | 11 + .../js-client/modules/admin_order_edits.mdx | 11 + .../js-client/modules/admin_orders.mdx | 11 + .../modules/admin_payment_collections.mdx | 11 + .../js-client/modules/admin_payments.mdx | 11 + .../js-client/modules/admin_price_lists.mdx | 11 + .../modules/admin_product_categories.mdx | 11 + .../js-client/modules/admin_product_tags.mdx | 11 + .../js-client/modules/admin_product_types.mdx | 11 + .../js-client/modules/admin_products.mdx | 11 + .../modules/admin_publishable_api_keys.mdx | 11 + .../js-client/modules/admin_regions.mdx | 11 + .../js-client/modules/admin_reservations.mdx | 11 + .../modules/admin_return_reasons.mdx | 11 + .../js-client/modules/admin_returns.mdx | 11 + .../modules/admin_sales_channels.mdx | 11 + .../modules/admin_shipping_options.mdx | 11 + .../modules/admin_shipping_profiles.mdx | 11 + .../modules/admin_stock_locations.mdx | 11 + .../js-client/modules/admin_store.mdx | 11 + .../js-client/modules/admin_swaps.mdx | 11 + .../js-client/modules/admin_tax_rates.mdx | 11 + .../js-client/modules/admin_uploads.mdx | 15 + .../js-client/modules/admin_users.mdx | 15 + .../js-client/modules/admin_variants.mdx | 11 + .../references/js-client/modules/auth.mdx | 11 + .../references/js-client/modules/carts.mdx | 11 + .../js-client/modules/collections.mdx | 11 + .../js-client/modules/customers.mdx | 11 + .../js-client/modules/gift_cards.mdx | 11 + .../references/js-client/modules/index.mdx | 355 + .../js-client/modules/internal-1.md | 125 - .../js-client/modules/internal-10.md | 484 - .../js-client/modules/internal-11.md | 81 - .../js-client/modules/internal-12.md | 113 - .../js-client/modules/internal-2.md | 136 - .../js-client/modules/internal-3.md | 247 - .../js-client/modules/internal-4.md | 73 - .../js-client/modules/internal-5.md | 9 - .../js-client/modules/internal-6.md | 80 - .../js-client/modules/internal-7.md | 80 - .../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 | 7138 -------- .../js-client/modules/internal-9.md | 25 - .../references/js-client/modules/internal.md | 31 - .../js-client/modules/line_items.mdx | 11 + .../js-client/modules/order_edits.mdx | 11 + .../references/js-client/modules/orders.mdx | 11 + .../js-client/modules/payment_collections.mdx | 11 + .../js-client/modules/payment_methods.mdx | 11 + .../js-client/modules/product_categories.mdx | 11 + .../js-client/modules/product_tags.mdx | 11 + .../js-client/modules/product_types.mdx | 11 + .../js-client/modules/product_variants.mdx | 11 + .../references/js-client/modules/products.mdx | 11 + .../references/js-client/modules/regions.mdx | 11 + .../js-client/modules/return_reasons.mdx | 11 + .../references/js-client/modules/returns.mdx | 11 + .../js-client/modules/shipping_options.mdx | 11 + .../references/js-client/modules/swaps.mdx | 15 + .../order_edits.OrderEditsResource.mdx | 170 + .../orders/classes/orders.OrdersResource.mdx | 266 + ...collections.PaymentCollectionsResource.mdx | 363 + ...payment_methods.PaymentMethodsResource.mdx | 54 + ...t_categories.ProductCategoriesResource.mdx | 127 + .../product_tags.ProductTagsResource.mdx | 64 + .../product_types.ProductTypesResource.mdx | 64 + ...oduct_variants.ProductVariantsResource.mdx | 119 + .../classes/products.ProductsResource.mdx | 187 + .../classes/regions.RegionsResource.mdx | 111 + .../return_reasons.ReturnReasonsResource.mdx | 109 + .../classes/returns.ReturnsResource.mdx | 62 + ...ipping_options.ShippingOptionsResource.mdx | 119 + .../swaps/classes/swaps.SwapsResource.mdx | 119 + .../swaps/modules/swaps.internal.mdx | 101 + www/apps/docs/sidebars.js | 181 +- 1604 files changed, 211689 insertions(+), 151746 deletions(-) create mode 100644 www/apps/docs/content/references/js-client/EventEmitter/interfaces/admin_discounts.internal.EventEmitter.Abortable.mdx create mode 100644 www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx create mode 100644 www/apps/docs/content/references/js-client/addresses/modules/addresses.internal.mdx create mode 100644 www/apps/docs/content/references/js-client/admin/classes/admin.Admin.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_auth/modules/admin_auth.internal.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_batch_jobs/modules/admin_batch_jobs.internal.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_collections/modules/admin_collections.internal.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_currencies/modules/admin_currencies.internal.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_custom/classes/admin_custom.AdminCustomResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_custom/modules/admin_custom.internal.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_customer_groups/modules/admin_customer_groups.internal.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_customers/modules/admin_customers.internal.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_invites/modules/admin_invites.internal.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_uploads/modules/admin_uploads.internal.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_users/classes/admin_users.AdminUsersResource.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_users/modules/admin_users.internal.mdx create mode 100644 www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx create mode 100644 www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx delete mode 100644 www/apps/docs/content/references/js-client/classes/AddressesResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/Admin.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminAuthResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminCollectionsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminCustomResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminCustomersResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminDiscountsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminDraftOrdersResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminInventoryItemsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminInvitesResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminNotesResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminOrdersResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminPriceListResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminProductCategoriesResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminProductTagsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminProductTypesResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminProductsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminRegionsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminReservationsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminReturnReasonsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminReturnsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminShippingOptionsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminStoresResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminSwapsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminUploadsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminUsersResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AdminVariantsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/AuthResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/CartsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/CollectionsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/CustomerResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/GiftCardsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/LineItemsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/OrderEditsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/OrdersResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/PaymentMethodsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/ProductTagsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/ProductTypesResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/ProductVariantsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/ProductsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/RegionsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/ReturnReasonsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/ReturnsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/SwapsResource.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-1.BaseEntity.md delete 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-1.User.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-12.Axios.md delete 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-2.AdminGetBatchPaginationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-2.AdminGetBatchParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-2.BatchJob.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-2.DateComparisonOperator.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Address.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.AdminDeleteProductsFromCollectionReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsPaginationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsCollectionReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.AdminPostProductsToCollectionReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Cart.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ClaimImage.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ClaimItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ClaimOrder.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ClaimTag.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Country.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Currency.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Customer.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.CustomerGroup.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Discount.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.DiscountCondition.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.DiscountRule.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.DraftOrder.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Fulfillment.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.FulfillmentItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.FulfillmentProvider.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.GiftCard.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.GiftCardTransaction.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Image.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.LineItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.LineItemAdjustment.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.LineItemTaxLine.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.MoneyAmount.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Order.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.OrderEdit.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.OrderItemChange.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Payment.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.PaymentCollection.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.PaymentProvider.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.PaymentSession.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.PriceList.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Product.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductCategory.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductCollection.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductOption.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductOptionValue.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductTag.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductType.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductVariant.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductVariantInventoryItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Refund.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Region.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Return.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ReturnItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ReturnReason.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.SalesChannel.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.SalesChannelLocation.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ShippingMethod.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ShippingMethodTaxLine.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ShippingOption.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ShippingOptionRequirement.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ShippingProfile.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Swap.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.TaxLine.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.TaxProvider.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.TaxRate.md delete 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-4.AdminGetCurrenciesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-4.AdminPostCurrenciesCurrencyReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-4.FindPaginationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.AdminGetCustomerGroupsGroupParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.AdminGetCustomerGroupsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsGroupReq.md delete 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.CustomerGroupsBatchCustomer.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.FilterableCustomerGroupProps.md delete 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.StringComparisonOperator.md delete 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.AdminListCustomerSelector.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminPostCustomersCustomerReq.md delete 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.Group.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AbstractEventBusModuleService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AbstractSearchService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem-2.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminCreateCondition.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsDiscountRuleParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminListOrdersSelector.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditions.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsCondition.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountDynamicCodesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountRule.md delete 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.AdminPriceSelectionParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminProductCategoriesReqBase.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminUpdateDiscountRule.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminUpsertCondition.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminUpsertConditionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Blob.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.CustomShippingOption.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroup-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroup.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroupUpdate.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Discount-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Discount-2.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Discount-3.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Discount.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Duplex.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.EventEmitter-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.FilterableCartProps.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.FilterableDiscountProps.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.FilterableLineItemAdjustmentProps.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.FilterableProductProps.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.FilterableProductVariantProps.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.FlagRouter.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.FulfillmentService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.GiftCard-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.GiftCard.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Image.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Item-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Item-2.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Item-3.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Item-4.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Item-5.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Item-6.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Item.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.MedusaError.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.NotificationProvider.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.OptionRequirement-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.OptionRequirement.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.OrdersReturnItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.PassThrough.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.PaymentMethod.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.PaymentService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.PriceSelectionParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductBatchProductCategory.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductBatchSalesChannel.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductOptionReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductProductCategoryReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductSalesChannelReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductTagReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductTypeReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-2.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-3.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantPricesCreateReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantPricesUpdateReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantReq-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Readable.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ReadableBase.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ReturnItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-2.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-3.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-2.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-3.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.StockLocationAddress-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.StockLocationAddress.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Stream.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Tag.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Transform.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.WritableBase.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal-2.Writable.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal-5.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractBatchJobStrategy.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractCartCompletionStrategy.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractFileService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractFulfillmentService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractNotificationService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPaymentProcessor.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPaymentService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPriceSelectionStrategy.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractTaxService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminCreateUserRequest.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePriceListPricesPricesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteUploadsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDiscountParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDiscountsDiscountCodeParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDraftOrdersParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetGiftCardsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsItemLocationLevelsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsItemParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetNotesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetNotificationsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetOrdersOrderParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetOrdersParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPaymentCollectionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPriceListPaginationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPriceListsPriceListProductsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductCategoriesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductCategoryParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTagsPaginationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTagsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTypesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductsVariantsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsPaginationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetReservationsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetReturnsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetSalesChannelsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetShippingOptionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetStockLocationsLocationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetStockLocationsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetSwapsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetTaxRatesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetTaxRatesTaxRateParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetVariantParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetVariantsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostAnalyticsConfigAnalyticsConfigReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostAnalyticsConfigReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDiscountsDiscountParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDiscountsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostGiftCardsGiftCardReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostGiftCardsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsInventoryItemParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsInventoryItemReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesInviteAcceptReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesInviteAcceptUserReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotesNoteReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotificationsNotificationResendReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsEditLineItemsLineItemReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsEditLineItemsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsOrderEditReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsRequestConfirmationReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersClaimCancel.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersClaimFulfillmentsCancelParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderArchiveParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCancel.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCaptureParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCompleteParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillementsCancelParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderRefundsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderRefundsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReturnsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShipmentParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShipmentReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersSwapCancelParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPaymentRefundsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListsPriceListPriceListReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListsPriceListReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductMetadataReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductOptionsOption.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductOptionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductVariantsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductVariantsVariantReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeysReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionCountriesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionFulfillmentProvidersReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionPaymentProvidersReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReservationsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReservationsReservationReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnReasonsReasonReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnReasonsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnsReturnReceiveReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsChannelProductsBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsChannelStockLocationsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsSalesChannelReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingOptionsOptionReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingOptionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingProfilesProfileReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingProfilesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsLocationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsLocationReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStoreReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostUploadsDownloadUrlReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPriceListPricesCreateReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPriceListPricesUpdateReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminRegionsRes.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminResetPasswordRequest.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminResetPasswordTokenRequest.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminUpdatePaymentCollectionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminUpdateUserRequest.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AnalyticsConfig.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AnalyticsConfigService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AuthService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.BatchJobService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.CartService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ClaimItemService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ClaimService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.CurrencyService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomShippingOption.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomShippingOptionService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomerGroupService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomerService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionCustomerGroup.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProduct.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductCollection.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductTag.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductType.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DraftOrderService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.EmptyQueryParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.EventBusService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.FilterableBatchJobProps.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.FilterablePriceListProps.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.FulfillmentOption.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.FulfillmentProviderService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.GetOrderEditsOrderEditParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.GetOrderEditsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPaymentsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPublishableApiKeySalesChannelsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPublishableApiKeysParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.GiftCardService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.IAdminPostUploadsFileReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.IdempotencyKey.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.IdempotencyKeyService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.Invite.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.Item.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.LineItemAdjustmentService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.LineItemService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.MiddlewareService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.NewTotalsService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.Note.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.NoteService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.Notification.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.NotificationService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.NumericalComparisonOperator.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.Oauth.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.OauthService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderEditItemChangeService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderEditService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.PaymentCollectionService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.PaymentProviderService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.PriceListService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.PricingService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductCategoryService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductCollectionService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTaxRate.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTypeService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTypeTaxRate.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantInventoryService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantMoneyAmount.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.PublishableApiKey.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.PublishableApiKeySalesChannel.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.RegionService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ReturnReasonService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ReturnService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelInventoryService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelLocationService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.SearchService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingAddressPayload.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingOptionService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingProfileService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingTaxRate.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StagedJob.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StagedJobService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.Store.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCollectionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCustomersCustomerOrdersParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetOrdersParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetPaymentCollectionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductCategoriesCategoryParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductCategoriesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductTagsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductTypesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductsPaginationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetRegionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetShippingOptionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetVariantsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetVariantsVariantParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePaymentCollectionSessionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostAuthReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartLineItemsItemReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartLineItemsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartPaymentSessionReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartPaymentSessionUpdateReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartShippingMethodReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerAcceptClaimReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerOrderClaimReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerPasswordTokenReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersResetPasswordReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostOrderEditsOrderEditDecline.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsSessionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostReturnsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostSearchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostSwapsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StrategyResolverService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.SwapService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.SystemPaymentProviderService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.TaxProviderService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.TaxRateService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.TokenService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.TotalsService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.TransactionBaseService.md delete 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.AddressCreatePayload.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.AddressPayload.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md create mode 100644 www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-1.UserRoles.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-2.BatchJobStatus.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.AllocationType.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.CartType.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.ClaimFulfillmentStatus.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.ClaimPaymentStatus.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.ClaimReason.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.ClaimType.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionOperator.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionType.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.DiscountRuleType.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.DraftOrderStatus.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.OrderEditItemChangeType.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.OrderEditStatus.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.OrderStatus.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.PaymentCollectionStatus.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.PriceListStatus.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.PriceListType.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.ProductStatus.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.RequirementType.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.ReturnStatus.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.ShippingOptionPriceType.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-3.ShippingProfileType.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.DefaultPriceType.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.DiscountConditionJoinTableForeignKey.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.MODULE_RESOURCE_TYPE.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.OrderStatus.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.internal.PaymentCollectionType.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.internal.PaymentSessionStatus.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.internal.PostgresError.md delete mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.internal.RefundReason.md create mode 100644 www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.BlobPropertyBag.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.File.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.FilePropertyBag.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.QueuingStrategy.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.QueuingStrategySize.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableByteStreamController.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStream.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamBYOBReader.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamBYOBRequest.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamDefaultController.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamDefaultReader.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamGenericReader.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamGetReaderOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamReadDoneResult.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamReadValueResult.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableWritablePair.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.StreamPipeOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingByteSource.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingDefaultSource.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSink.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkAbortCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkCloseCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkStartCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkWriteCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSource.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourceCancelCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourcePullCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourceStartCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStream.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStreamDefaultController.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStreamDefaultWriter.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosAdapter.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosBasicCredentials.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosDefaults.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosError.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosInstance.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosInterceptorManager.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosPromise.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosProxyConfig.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosRequestTransformer.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponse.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponseTransformer.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.Cancel.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.CancelToken.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.Config.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.HTTPResponse.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.HeadersDefaults.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.RetryConfig.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.TransitionalOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-3.Boolean.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-5.RequestOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ArrayBufferView.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ArrayLike.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncGenerator.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncGeneratorFunction.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterable.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterableIterator.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterator.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.BlobOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.Buffer.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.BufferConstructor.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.CallSite.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.CreateNoteInput.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.CreateUserInput.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.DuplexOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ErrnoException.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.Error.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter.Abortable.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitterOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.FindConfig.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ICacheService.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IEventBusModuleService.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IEventBusService.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IFlagRouter.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IInventoryService.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ISearchService.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IStockLocationService.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ITransactionBaseService.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.Iterable.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IterableIterator.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.Iterator.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IteratorReturnResult.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IteratorYieldResult.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.JoinerServiceConfig.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.JoinerServiceConfigAlias.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.Logger.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.NumericalComparisonOperator.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.Object.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.PromiseLike.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.QueuingStrategy.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.QueuingStrategySize.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadWriteStream.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableByteStreamController.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableByteStreamControllerCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStream-1.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStream.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultController.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReadDoneResult.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReadValueResult.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReader.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamErrorCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamGenericReader.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableWritablePair.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.SharedArrayBuffer.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.SharedArrayBufferConstructor.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.StaticEventEmitterOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.StreamPipeOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.StringComparisonOperator.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.TransformOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingByteSource.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSink.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkAbortCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkCloseCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkStartCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkWriteCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSource.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourceCancelCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourcePullCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourceStartCallback.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UpdateUserInput.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStream-1.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStream.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStreamDefaultController.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStreamDefaultWriter.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8._DOMEventTarget.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8._NodeEventTarget.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.FinishedOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.Pipe.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.PipelineOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.ReadableOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.StreamOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.WritableOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.CustomFindOptions.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.FindConfig.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.FulfillmentService.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IBatchJobStrategy.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ICartCompletionStrategy.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IFileService.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.INotificationService.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IPriceSelectionStrategy.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ITaxCalculationStrategy.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ITaxService.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentProcessor.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentProcessorError.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentService.md create mode 100644 www/apps/docs/content/references/js-client/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx create mode 100644 www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.FinishedOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.Pipe.mdx create mode 100644 www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.PipelineOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.StreamOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.finished.mdx create mode 100644 www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.pipeline.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/addresses.internal.AddressCreatePayload.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/addresses.internal.AddressPayload.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/addresses.internal.StorePostCustomersCustomerAddressesAddressReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/addresses.internal.StorePostCustomersCustomerAddressesReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.AdminPostAuthReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.BaseEntity.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.SoftDeletableEntity.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.User.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.AdminGetBatchPaginationParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.AdminGetBatchParams.mdx rename www/apps/docs/content/references/js-client/{classes/internal-2.AdminPostBatchesReq.md => internal/classes/admin_batch_jobs.internal.AdminPostBatchesReq.mdx} (56%) create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.BatchJob.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.DateComparisonOperator.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Address.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminDeleteProductsFromCollectionReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminGetCollectionsPaginationParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminGetCollectionsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminPostCollectionsCollectionReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminPostCollectionsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminPostProductsToCollectionReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Cart.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimImage.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimItem.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimOrder.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimTag.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Country.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Currency.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Customer.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.CustomerGroup.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Discount.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.DiscountCondition.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.DiscountRule.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.DraftOrder.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Fulfillment.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.FulfillmentItem.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.FulfillmentProvider.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.GiftCard.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.GiftCardTransaction.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Image.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItem.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItemAdjustment.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItemTaxLine.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.MoneyAmount.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Order.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.OrderEdit.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.OrderItemChange.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Payment.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PaymentCollection.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PaymentProvider.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PaymentSession.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PriceList.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Product.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductCategory.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductCollection.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductOption.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductOptionValue.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductTag.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductType.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductVariant.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductVariantInventoryItem.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Refund.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Region.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Return.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ReturnItem.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ReturnReason.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.SalesChannel.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.SalesChannelLocation.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingMethod.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingMethodTaxLine.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingOption.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingOptionRequirement.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingProfile.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Swap.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TaxLine.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TaxProvider.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TaxRate.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TrackingLink.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_currencies.internal.AdminGetCurrenciesParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_currencies.internal.AdminPostCurrenciesCurrencyReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_currencies.internal.FindPaginationParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminGetCustomerGroupsGroupParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminGetCustomerGroupsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsGroupCustomersBatchReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsGroupReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.CustomerGroupsBatchCustomer.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.FilterableCustomerGroupProps.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.FindParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.StringComparisonOperator.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminGetCustomersParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminListCustomerSelector.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminPostCustomersCustomerReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminPostCustomersReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.Group.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractEventBusModuleService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractSearchService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdditionalItem-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdditionalItem-2.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdditionalItem.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminCreateCondition.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminGetDiscountsDiscountConditionsConditionParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminGetDiscountsDiscountRuleParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminGetDiscountsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminListOrdersSelector.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsCondition.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionBatchParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionBatchReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountDynamicCodesReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountRule.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPriceSelectionParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminProductCategoriesReqBase.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminUpdateDiscountRule.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminUpsertCondition.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminUpsertConditionsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomShippingOption.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomerGroup-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomerGroup.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomerGroupUpdate.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount-2.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount-3.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableCartProps.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableDiscountProps.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableLineItemAdjustmentProps.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableProductProps.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableProductVariantProps.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FulfillmentService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.GiftCard-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.GiftCard.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Image.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-2.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-3.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-4.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-5.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-6.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.NotificationProvider.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.OptionRequirement-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.OptionRequirement.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.OrdersReturnItem.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PaymentMethod.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PaymentService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PriceSelectionParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductBatchProductCategory.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductBatchSalesChannel.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductOptionReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductProductCategoryReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductSalesChannelReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductTagReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductTypeReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq-2.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq-3.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantPricesCreateReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantPricesUpdateReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantReq-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnItem.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping-2.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping-3.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod-2.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod-3.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.StockLocationAddress-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.StockLocationAddress.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Tag.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFileService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFulfillmentService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractNotificationService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentProcessor.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractTaxService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeletePriceListPricesPricesReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteUploadsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetDiscountParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetDiscountsDiscountCodeParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetDraftOrdersParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetGiftCardsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetInventoryItemsItemLocationLevelsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetInventoryItemsItemParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetInventoryItemsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetNotesParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetNotificationsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetOrdersOrderParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetOrdersParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetPaymentCollectionsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetPriceListPaginationParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetPriceListsPriceListProductsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductCategoriesParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductCategoryParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductTagsPaginationParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductTagsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductTypesParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductsVariantsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetRegionsPaginationParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetRegionsParams.mdx rename www/apps/docs/content/references/js-client/{classes/internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md => internal/classes/admin_discounts.internal.internal.AdminGetRegionsRegionFulfillmentOptionsRes.mdx} (56%) create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetReservationsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetReturnsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetSalesChannelsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetShippingOptionsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetStockLocationsLocationParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetStockLocationsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetSwapsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetTaxRatesParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetTaxRatesTaxRateParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetVariantParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetVariantsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostAnalyticsConfigAnalyticsConfigReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostAnalyticsConfigReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDiscountsDiscountParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDiscountsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostGiftCardsGiftCardReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostGiftCardsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsInventoryItemParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsInventoryItemReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInvitesInviteAcceptReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInvitesInviteAcceptUserReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInvitesReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostNotesNoteReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostNotesReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostNotificationsNotificationResendReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsEditLineItemsLineItemReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsEditLineItemsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsOrderEditReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsRequestConfirmationReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersClaimCancel.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersClaimFulfillmentsCancelParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderArchiveParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderCancel.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderCaptureParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderCompleteParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillementsCancelParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillmentsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillmentsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderRefundsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderRefundsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderReturnsParams.mdx rename www/apps/docs/content/references/js-client/{classes/internal-8.internal.AdminPostOrdersOrderReturnsReq.md => internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderReturnsReq.mdx} (51%) create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShipmentParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShipmentReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShippingMethodsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShippingMethodsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsParams.mdx rename www/apps/docs/content/references/js-client/{classes/internal-8.internal.AdminPostOrdersOrderSwapsReq.md => internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsReq.mdx} (56%) create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersSwapCancelParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPaymentRefundsReq.mdx rename www/apps/docs/content/references/js-client/{classes/internal-8.internal.AdminPostPriceListPricesPricesReq.md => internal/classes/admin_discounts.internal.internal.AdminPostPriceListPricesPricesReq.mdx} (68%) create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPriceListsPriceListPriceListReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPriceListsPriceListReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryProductsBatchParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryProductsBatchReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductMetadataReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductOptionsOption.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductOptionsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductVariantsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductVariantsVariantReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPublishableApiKeysReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionCountriesReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionFulfillmentProvidersReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionPaymentProvidersReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReservationsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReservationsReservationReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReturnReasonsReasonReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReturnReasonsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReturnsReturnReceiveReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsChannelProductsBatchReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsChannelStockLocationsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsSalesChannelReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingOptionsOptionReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingOptionsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingProfilesProfileReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingProfilesReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsLocationParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsLocationReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStoreReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductTypesParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductTypesReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateShippingOptionsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostUploadsDownloadUrlReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPriceListPricesCreateReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPriceListPricesUpdateReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminResetPasswordRequest.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminResetPasswordTokenRequest.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminUpdatePaymentCollectionsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AnalyticsConfig.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AnalyticsConfigService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AuthService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.BatchJobService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CartService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimItemService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CurrencyService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomShippingOption.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomShippingOptionService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerGroupService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProduct.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProductCollection.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProductTag.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProductType.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DraftOrderService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.EmptyQueryParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.EventBusService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FilterableBatchJobProps.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FilterablePriceListProps.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FulfillmentOption.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FulfillmentProviderService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetOrderEditsOrderEditParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetOrderEditsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetPaymentsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetPublishableApiKeySalesChannelsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetPublishableApiKeysParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GiftCardService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IAdminPostUploadsFileReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IdempotencyKey.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IdempotencyKeyService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Invite.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Item.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemAdjustmentService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.MiddlewareService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NewTotalsService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Note.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NoteService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Notification.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NotificationService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NumericalComparisonOperator.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Oauth.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OauthService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditItemChangeService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentCollectionService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentProviderService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PriceListService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PricingService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCategoryService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCollectionService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTaxRate.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTypeService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTypeTaxRate.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantMoneyAmount.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PublishableApiKey.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PublishableApiKeySalesChannel.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.RegionService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnReasonService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelInventoryService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelLocationService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SearchService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingAddressPayload.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingOptionService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingProfileService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingTaxRate.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StagedJob.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StagedJobService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Store.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetCollectionsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetCustomersCustomerOrdersPaginationParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetCustomersCustomerOrdersParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetOrdersParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetPaymentCollectionsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductCategoriesCategoryParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductCategoriesParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductTagsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductTypesParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductsPaginationParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetRegionsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetShippingOptionsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetVariantsParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetVariantsVariantParams.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePaymentCollectionSessionsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostAuthReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartLineItemsItemReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartLineItemsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartPaymentSessionReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartPaymentSessionUpdateReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartShippingMethodReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerAcceptClaimReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerOrderClaimReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerPasswordTokenReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersResetPasswordReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostOrderEditsOrderEditDecline.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostPaymentCollectionsBatchSessionsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostPaymentCollectionsSessionsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostReturnsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostSearchReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostSwapsReq.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StrategyResolverService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SwapService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SystemPaymentProviderService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxProviderService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxRateService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TokenService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TotalsService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TransactionBaseService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.UserService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/swaps.internal.Axios.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/classes/swaps.internal.Client.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_auth.internal.UserRoles.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_batch_jobs.internal.BatchJobStatus.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.AllocationType.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.CartType.mdx rename www/apps/docs/content/references/js-client/{enums/internal-3.FulfillmentStatus.md => internal/enums/admin_collections.internal.ClaimFulfillmentStatus.mdx} (52%) create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimPaymentStatus.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimReason.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimType.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionOperator.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionType.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountRuleType.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DraftOrderStatus.mdx rename www/apps/docs/content/references/js-client/{enums/internal-3.SwapFulfillmentStatus.md => internal/enums/admin_collections.internal.FulfillmentStatus.mdx} (50%) create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditItemChangeType.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditStatus.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderStatus.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentCollectionStatus.mdx rename www/apps/docs/content/references/js-client/{enums/internal-3.PaymentStatus.md => internal/enums/admin_collections.internal.PaymentStatus.mdx} (50%) create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListStatus.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListType.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ProductStatus.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.RequirementType.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ReturnStatus.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingOptionPriceType.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingProfileType.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapFulfillmentStatus.mdx rename www/apps/docs/content/references/js-client/{enums/internal-3.SwapPaymentStatus.md => internal/enums/admin_collections.internal.SwapPaymentStatus.mdx} (51%) create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.DefaultPriceType.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.DiscountConditionJoinTableForeignKey.mdx rename www/apps/docs/content/references/js-client/{enums/internal-8.FulfillmentStatus.md => internal/enums/admin_discounts.internal.FulfillmentStatus.mdx} (52%) create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.MODULE_RESOURCE_TYPE.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.OrderStatus.mdx rename www/apps/docs/content/references/js-client/{enums/internal-8.PaymentStatus.md => internal/enums/admin_discounts.internal.PaymentStatus.mdx} (50%) create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PaymentCollectionType.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PostgresError.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.RefundReason.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_collections.internal.Boolean.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_custom.internal.RequestOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ArrayBufferView.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ArrayLike.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGenerator.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterable.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterator.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BlobOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Buffer.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CallSite.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CreateNoteInput.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CreateUserInput.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.DuplexOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ErrnoException.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Error.mdx rename www/apps/docs/content/references/js-client/{interfaces/internal-8.EventEmitter-2.md => internal/interfaces/admin_discounts.internal.EventEmitter-2.mdx} (52%) create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.EventEmitterOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.FindConfig.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ICacheService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusModuleService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IFlagRouter.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IInventoryService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ISearchService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ITransactionBaseService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterable.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IterableIterator.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterator.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IteratorReturnResult.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IteratorYieldResult.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.JoinerServiceConfig.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.JoinerServiceConfigAlias.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Logger.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.NumericalComparisonOperator.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Object.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.PromiseLike.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.QueuingStrategy.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.QueuingStrategySize.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableByteStreamController.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableByteStreamControllerCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultController.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadDoneResult.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadValueResult.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReader.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamErrorCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamGenericReader.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableWritablePair.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SharedArrayBuffer.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SharedArrayBufferConstructor.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.StaticEventEmitterOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.StreamPipeOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.StringComparisonOperator.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.TransformOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingByteSource.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSink.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkAbortCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkCloseCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkStartCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkWriteCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSource.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceCancelCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourcePullCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceStartCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UpdateUserInput.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultController.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultWriter.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._DOMEventTarget.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._NodeEventTarget.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.CustomFindOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.FindConfig.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.FulfillmentService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ICartCompletionStrategy.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IFileService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.INotificationService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxCalculationStrategy.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentService.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.BlobPropertyBag.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.File.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.FilePropertyBag.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.QueuingStrategy.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.QueuingStrategySize.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableByteStreamController.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStream.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBReader.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBRequest.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultController.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultReader.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamGenericReader.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamGetReaderOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamReadDoneResult.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamReadValueResult.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableWritablePair.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.StreamPipeOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingByteSource.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingDefaultSource.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSink.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkAbortCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkCloseCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkStartCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkWriteCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSource.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceCancelCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourcePullCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceStartCallback.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStream.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultController.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultWriter.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosAdapter.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosBasicCredentials.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosDefaults.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosError.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInstance.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInterceptorManager.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosPromise.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosProxyConfig.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosRequestTransformer.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosResponse.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosResponseTransformer.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.Cancel.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.CancelToken.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.Config.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.HTTPResponse.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.HeadersDefaults.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.RetryConfig.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.TransitionalOptions.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.EventEmitter.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-1.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-2.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-3.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-4.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal.mdx create mode 100644 www/apps/docs/content/references/js-client/line_items/classes/line_items.LineItemsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/addresses.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_auth.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_batch_jobs.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_collections.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_currencies.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_custom.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_customer_groups.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_customers.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_discounts.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_draft_orders.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_gift_cards.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_inventory_item.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_invites.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_notes.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_notifications.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_order_edits.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_orders.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_payment_collections.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_payments.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_price_lists.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_product_categories.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_product_tags.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_product_types.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_products.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_publishable_api_keys.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_regions.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_reservations.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_return_reasons.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_returns.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_sales_channels.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_shipping_options.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_shipping_profiles.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_stock_locations.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_store.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_swaps.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_tax_rates.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_uploads.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_users.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/admin_variants.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/auth.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/carts.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/collections.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/customers.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/gift_cards.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/index.mdx delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-1.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-10.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-11.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-12.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-2.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-3.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-4.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-5.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-6.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-7.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.EventEmitter.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal-1.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal-2.finished.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal-2.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal-2.pipeline.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal-3.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal-4.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-9.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal.md create mode 100644 www/apps/docs/content/references/js-client/modules/line_items.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/order_edits.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/orders.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/payment_collections.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/payment_methods.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/product_categories.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/product_tags.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/product_types.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/product_variants.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/products.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/regions.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/return_reasons.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/returns.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/shipping_options.mdx create mode 100644 www/apps/docs/content/references/js-client/modules/swaps.mdx create mode 100644 www/apps/docs/content/references/js-client/order_edits/classes/order_edits.OrderEditsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/orders/classes/orders.OrdersResource.mdx create mode 100644 www/apps/docs/content/references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/product_categories/classes/product_categories.ProductCategoriesResource.mdx create mode 100644 www/apps/docs/content/references/js-client/product_tags/classes/product_tags.ProductTagsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/product_types/classes/product_types.ProductTypesResource.mdx create mode 100644 www/apps/docs/content/references/js-client/product_variants/classes/product_variants.ProductVariantsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/products/classes/products.ProductsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/regions/classes/regions.RegionsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/returns/classes/returns.ReturnsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/swaps/classes/swaps.SwapsResource.mdx create mode 100644 www/apps/docs/content/references/js-client/swaps/modules/swaps.internal.mdx diff --git a/docs-util/packages/typedoc-config/js-client.js b/docs-util/packages/typedoc-config/js-client.js index 4ae642a700..3778ef27ec 100644 --- a/docs-util/packages/typedoc-config/js-client.js +++ b/docs-util/packages/typedoc-config/js-client.js @@ -16,10 +16,10 @@ module.exports = { hideInPageTOC: true, hideBreadcrumbs: true, plugin: [ - ...globalTypedocOptions.plugin, - "typedoc-plugin-merge-modules", + "typedoc-plugin-markdown-medusa", "typedoc-plugin-reference-excluder", "typedoc-plugin-frontmatter", + "typedoc-plugin-rename-defaults", "typedoc-plugin-modules", ], exclude: [ @@ -32,4 +32,20 @@ module.exports = { displayed_sidebar: "jsClientSidebar", }, internalModule: "internal", + formatting: { + "*": { + showCommentsAsHeader: true, + sections: { + member_sources_definedIn: false, + reflection_hierarchy: false, + }, + parameterStyle: "component", + parameterComponent: "ParameterTypes", + mdxImports: [ + `import ParameterTypes from "@site/src/components/ParameterTypes"`, + ], + }, + }, + objectLiteralTypeDeclarationStyle: "component", + mdxOutput: true, } diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/package.json b/docs-util/packages/typedoc-plugin-markdown-medusa/package.json index 0bd6a32b85..9644f95d91 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/package.json +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/package.json @@ -32,7 +32,6 @@ "typedoc" ], "dependencies": { - "handlebars": "^4.7.8", - "yaml": "^2.3.2" + "handlebars": "^4.7.8" } } diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comment-tag.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comment-tag.ts index 6b0242e334..10330212f0 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comment-tag.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comment-tag.ts @@ -9,6 +9,11 @@ export default function (theme: MarkdownTheme) { function (tag: CommentTag, commentLevel = 4, parent = null) { const { showCommentsAsHeader, showCommentsAsDetails } = theme.getFormattingOptionsForLocation() + if (tag.tag === "@schema") { + tag.content.forEach((content, index) => { + tag.content[index].text = getDescriptionFromSchema(content.text) + }) + } const tagTitle = camelToTitleCase(tag.tag.substring(1)), tagContent = Handlebars.helpers.comment(tag.content) @@ -24,4 +29,12 @@ export default function (theme: MarkdownTheme) { return `**${tagTitle}**\n\n${tagContent}` } ) + + function getDescriptionFromSchema(content: string) { + const regex = new RegExp(/description: "(?.*)"/) + + const matchDescription = content.match(regex) + + return matchDescription?.groups?.description || content + } } diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comment.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comment.ts index 7090cfdf13..e5f3882193 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comment.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comment.ts @@ -18,6 +18,7 @@ export default function (theme: MarkdownTheme) { case "@label": case "@inheritdoc": break + case "@schema": case "@link": case "@linkcode": case "@linkplain": { diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comments.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comments.ts index cc791956ec..2fc39eb206 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comments.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comments.ts @@ -17,11 +17,10 @@ export default function () { md.push(Handlebars.helpers.comment(comment.summary)) } - const filteredTags = comment.blockTags - .filter((tag) => tag.tag !== "@returns") - .filter((tag) => tag.tag !== "@example") - if (showTags && comment.blockTags?.length) { + const filteredTags = comment.blockTags + .filter((tag) => tag.tag !== "@returns") + .filter((tag) => tag.tag !== "@example") const tags = filteredTags.map((tag) => { return Handlebars.helpers.commentTag( tag, diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-formatter.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-formatter.ts index 0a63433d09..6ebca4a387 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-formatter.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-formatter.ts @@ -256,7 +256,7 @@ export function getTypeChildren( switch (reflectionType.type) { case "reference": // eslint-disable-next-line no-case-declarations - const referencedReflection = project.getChildByName(reflectionType.name) + const referencedReflection = project?.getChildByName(reflectionType.name) if ( referencedReflection instanceof DeclarationReflection && diff --git a/docs-util/yarn.lock b/docs-util/yarn.lock index 6a2bc84e25..254567439e 100644 --- a/docs-util/yarn.lock +++ b/docs-util/yarn.lock @@ -2846,7 +2846,6 @@ __metadata: copyfiles: ^2.4.1 handlebars: ^4.7.8 typescript: ^4.6 - yaml: ^2.3.2 peerDependencies: typedoc: 0.25.x languageName: unknown diff --git a/www/apps/docs/content/js-client/overview.md b/www/apps/docs/content/js-client/overview.md index b9e247e98b..a0a4356c8e 100644 --- a/www/apps/docs/content/js-client/overview.md +++ b/www/apps/docs/content/js-client/overview.md @@ -54,7 +54,7 @@ Make sure to set `moduleResolution` in your `tsconfig.json` to `nodenext` or `no You'll find in the sidebar of this reference names of different resources. These resources are properties in the Medusa instance you initialize and you can access them directly using the instance. Then, you'll be able to access the methods or nested resources within those resources. -For example, to create a new customer you can access the [create](/references/js-client/classes/CustomerResource#create) method under the [customers](/references/js-client/classes/CustomerResource) property of your client: +For example, to create a new customer you can access the [create](../references/js-client/customers/classes/customers.CustomerResource.mdx#create) method under the [customers](../references/js-client/customers/classes/customers.CustomerResource.mdx) property of your client: ```ts import Medusa from "@medusajs/medusa-js" @@ -89,7 +89,7 @@ You can follow [this guide](https://docs.medusajs.com/api/admin#authentication) ### Using cookies -Authentication using cookies is done automatically by Axios, which is used within the Medusa JS Client, when authenticating using the [auth](/references/js-client/classes/AuthResource) API Routes. After authentication, all subsequent calls will be authenticated. +Authentication using cookies is done automatically by Axios, which is used within the Medusa JS Client, when authenticating using the [auth](../references/js-client/auth/classes/auth.AuthResource.mdx) API Routes. After authentication, all subsequent calls will be authenticated. --- 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 6887ae9977..a1b70b14d3 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-3.DiscountRuleType.md) 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/internal/enums/admin_collections.internal.DiscountRuleType.mdx) 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-3.AllocationType.md) 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/internal/enums/admin_collections.internal.AllocationType.mdx) 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/EventEmitter/interfaces/admin_discounts.internal.EventEmitter.Abortable.mdx b/www/apps/docs/content/references/js-client/EventEmitter/interfaces/admin_discounts.internal.EventEmitter.Abortable.mdx new file mode 100644 index 0000000000..2ba68a72b2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/EventEmitter/interfaces/admin_discounts.internal.EventEmitter.Abortable.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Abortable + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[EventEmitter](../../internal/modules/admin_discounts.internal.EventEmitter.mdx).Abortable + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx b/www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx new file mode 100644 index 0000000000..c029af6b27 --- /dev/null +++ b/www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx @@ -0,0 +1,176 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AddressesResource + +[addresses](../../modules/addresses.mdx).AddressesResource + +## Methods + +### addAddress + +▸ **addAddress**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +Adds an address to a customers saved addresses + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCustomersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteAddress + +▸ **deleteAddress**(`address_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +Deletes an address of a customer + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCustomersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateAddress + +▸ **updateAddress**(`address_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +Update an address of a customer + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCustomersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/addresses/modules/addresses.internal.mdx b/www/apps/docs/content/references/js-client/addresses/modules/addresses.internal.mdx new file mode 100644 index 0000000000..49afd79060 --- /dev/null +++ b/www/apps/docs/content/references/js-client/addresses/modules/addresses.internal.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +## Classes + +- [AddressCreatePayload](../../internal/classes/addresses.internal.AddressCreatePayload.mdx) +- [AddressPayload](../../internal/classes/addresses.internal.AddressPayload.mdx) +- [StorePostCustomersCustomerAddressesAddressReq](../../internal/classes/addresses.internal.StorePostCustomersCustomerAddressesAddressReq.mdx) +- [StorePostCustomersCustomerAddressesReq](../../internal/classes/addresses.internal.StorePostCustomersCustomerAddressesReq.mdx) + +## Type Aliases + +### Record + +Ƭ **Record**<`K`, `T`\>: { [P in K]: T } + +Construct a type with a set of properties K of type T + +#### Type parameters + + diff --git a/www/apps/docs/content/references/js-client/admin/classes/admin.Admin.mdx b/www/apps/docs/content/references/js-client/admin/classes/admin.Admin.mdx new file mode 100644 index 0000000000..f6df12ceef --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin/classes/admin.Admin.mdx @@ -0,0 +1,318 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Admin + +[admin](../../modules/admin.mdx).Admin + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx b/www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx new file mode 100644 index 0000000000..e63198a132 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx @@ -0,0 +1,205 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminAuthResource + +[admin/auth](../../modules/admin_auth.mdx).AdminAuthResource + +## Methods + +### createSession + +▸ **createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/admin_auth.internal.mdx#adminauthres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/admin_auth.internal.mdx#adminauthres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminAuthRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Creates an authenticated session + +___ + +### deleteSession + +▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Description + +destroys an authenticated session + +___ + +### getSession + +▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/admin_auth.internal.mdx#adminauthres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/admin_auth.internal.mdx#adminauthres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminAuthRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves an authenticated session +Usually used to check if authenticated session is alive. + +___ + +### getToken + +▸ **getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBearerAuthRes`](../modules/admin_auth.internal.mdx#adminbearerauthres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBearerAuthRes`](../modules/admin_auth.internal.mdx#adminbearerauthres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminBearerAuthRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a new JWT access token diff --git a/www/apps/docs/content/references/js-client/admin_auth/modules/admin_auth.internal.mdx b/www/apps/docs/content/references/js-client/admin_auth/modules/admin_auth.internal.mdx new file mode 100644 index 0000000000..912d9d731d --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_auth/modules/admin_auth.internal.mdx @@ -0,0 +1,163 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +## Enumerations + +- [UserRoles](../../internal/enums/admin_auth.internal.UserRoles.mdx) + +## Classes + +- [AdminPostAuthReq](../../internal/classes/admin_auth.internal.AdminPostAuthReq.mdx) +- [BaseEntity](../../internal/classes/admin_auth.internal.BaseEntity.mdx) +- [SoftDeletableEntity](../../internal/classes/admin_auth.internal.SoftDeletableEntity.mdx) +- [User](../../internal/classes/admin_auth.internal.User.mdx) + +## Type Aliases + +### AdminAuthRes + +Ƭ **AdminAuthRes**: `Object` + +#### Schema + +AdminAuthRes +type: object +required: + - user +properties: + user: + description: User details. + $ref: "#/components/schemas/User" + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### AdminBearerAuthRes + +Ƭ **AdminBearerAuthRes**: `Object` + +#### Schema + +AdminBearerAuthRes +type: object +properties: + accessToken: + description: Access token for subsequent authorization. + type: string + +#### Type declaration + + + +___ + +### Exclude + +Ƭ **Exclude**<`T`, `U`\>: `T` extends `U` ? `never` : `T` + +Exclude from T those types that are assignable to U + +#### Type parameters + + + +___ + +### Omit + +Ƭ **Omit**<`T`, `K`\>: [`Pick`](admin_auth.internal.mdx#pick)<`T`, [`Exclude`](admin_auth.internal.mdx#exclude)\> + +Construct a type with the properties of T except for those in type K. + +#### Type parameters + + + +___ + +### 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 + + diff --git a/www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx b/www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx new file mode 100644 index 0000000000..b21480863f --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx @@ -0,0 +1,264 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminBatchJobsResource + +[admin/batch-jobs](../../modules/admin_batch_jobs.mdx).AdminBatchJobsResource + +## Methods + +### cancel + +▸ **cancel**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminBatchJobRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### confirm + +▸ **confirm**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminBatchJobRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminBatchJobRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobListRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjoblistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobListRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjoblistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminBatchJobListRes", + "type": "[`PaginatedResponse`](../modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `batch_jobs`: [`BatchJob`](../../internal/classes/admin_batch_jobs.internal.BatchJob.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminBatchJobRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_batch_jobs/modules/admin_batch_jobs.internal.mdx b/www/apps/docs/content/references/js-client/admin_batch_jobs/modules/admin_batch_jobs.internal.mdx new file mode 100644 index 0000000000..8552a7b5bb --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_batch_jobs/modules/admin_batch_jobs.internal.mdx @@ -0,0 +1,181 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +## Enumerations + +- [BatchJobStatus](../../internal/enums/admin_batch_jobs.internal.BatchJobStatus.mdx) + +## Classes + +- [AdminGetBatchPaginationParams](../../internal/classes/admin_batch_jobs.internal.AdminGetBatchPaginationParams.mdx) +- [AdminGetBatchParams](../../internal/classes/admin_batch_jobs.internal.AdminGetBatchParams.mdx) +- [AdminPostBatchesReq](../../internal/classes/admin_batch_jobs.internal.AdminPostBatchesReq.mdx) +- [BatchJob](../../internal/classes/admin_batch_jobs.internal.BatchJob.mdx) +- [DateComparisonOperator](../../internal/classes/admin_batch_jobs.internal.DateComparisonOperator.mdx) + +## Type Aliases + +### AdminBatchJobListRes + +Ƭ **AdminBatchJobListRes**: [`PaginatedResponse`](admin_batch_jobs.internal.mdx#paginatedresponse) & { `batch_jobs`: [`BatchJob`](../../internal/classes/admin_batch_jobs.internal.BatchJob.mdx)[] } + +#### 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 + +___ + +### AdminBatchJobRes + +Ƭ **AdminBatchJobRes**: `Object` + +#### Schema + +AdminBatchJobRes +type: object +required: + - batch_job +properties: + batch_job: + description: Batch job details. + $ref: "#/components/schemas/BatchJob" + +#### Type declaration + + + +___ + +### BatchJobResultError + +Ƭ **BatchJobResultError**: `Object` + +#### Index signature + +▪ [key: `string`]: `unknown` + +#### Type declaration + + + +___ + +### BatchJobResultStatDescriptor + +Ƭ **BatchJobResultStatDescriptor**: `Object` + +#### Type declaration + + + +___ + +### PaginatedResponse + +Ƭ **PaginatedResponse**: `Object` + +#### Type declaration + + diff --git a/www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx b/www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx new file mode 100644 index 0000000000..b92a1f5025 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx @@ -0,0 +1,418 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminCollectionsResource + +[admin/collections](../../modules/admin_collections.mdx).AdminCollectionsResource + +## Methods + +### addProducts + +▸ **addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminCollectionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Updates products associated with a Product Collection + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "Created collection.", + "children": [ + { + "name": "AdminCollectionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Creates a collection. + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "Deleted response", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +deletes a collection + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsListRes`](../modules/admin_collections.internal.mdx#admincollectionslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsListRes`](../modules/admin_collections.internal.mdx#admincollectionslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a list of collections matching the query.", + "children": [ + { + "name": "AdminCollectionsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Lists collections matching a query + +___ + +### removeProducts + +▸ **removeProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/admin_collections.internal.mdx#admindeleteproductsfromcollectionres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/admin_collections.internal.mdx#admindeleteproductsfromcollectionres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDeleteProductsFromCollectionRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Removes products associated with a Product Collection + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the collection with the given id", + "children": [ + { + "name": "AdminCollectionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +get a collection + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated collection.", + "children": [ + { + "name": "AdminCollectionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Updates a collection diff --git a/www/apps/docs/content/references/js-client/admin_collections/modules/admin_collections.internal.mdx b/www/apps/docs/content/references/js-client/admin_collections/modules/admin_collections.internal.mdx new file mode 100644 index 0000000000..6cdbd3f19f --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_collections/modules/admin_collections.internal.mdx @@ -0,0 +1,261 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +## Enumerations + +- [AllocationType](../../internal/enums/admin_collections.internal.AllocationType.mdx) +- [CartType](../../internal/enums/admin_collections.internal.CartType.mdx) +- [ClaimFulfillmentStatus](../../internal/enums/admin_collections.internal.ClaimFulfillmentStatus.mdx) +- [ClaimPaymentStatus](../../internal/enums/admin_collections.internal.ClaimPaymentStatus.mdx) +- [ClaimReason](../../internal/enums/admin_collections.internal.ClaimReason.mdx) +- [ClaimType](../../internal/enums/admin_collections.internal.ClaimType.mdx) +- [DiscountConditionOperator](../../internal/enums/admin_collections.internal.DiscountConditionOperator.mdx) +- [DiscountConditionType](../../internal/enums/admin_collections.internal.DiscountConditionType.mdx) +- [DiscountRuleType](../../internal/enums/admin_collections.internal.DiscountRuleType.mdx) +- [DraftOrderStatus](../../internal/enums/admin_collections.internal.DraftOrderStatus.mdx) +- [FulfillmentStatus](../../internal/enums/admin_collections.internal.FulfillmentStatus.mdx) +- [OrderEditItemChangeType](../../internal/enums/admin_collections.internal.OrderEditItemChangeType.mdx) +- [OrderEditStatus](../../internal/enums/admin_collections.internal.OrderEditStatus.mdx) +- [OrderStatus](../../internal/enums/admin_collections.internal.OrderStatus.mdx) +- [PaymentCollectionStatus](../../internal/enums/admin_collections.internal.PaymentCollectionStatus.mdx) +- [PaymentStatus](../../internal/enums/admin_collections.internal.PaymentStatus.mdx) +- [PriceListStatus](../../internal/enums/admin_collections.internal.PriceListStatus.mdx) +- [PriceListType](../../internal/enums/admin_collections.internal.PriceListType.mdx) +- [ProductStatus](../../internal/enums/admin_collections.internal.ProductStatus.mdx) +- [RequirementType](../../internal/enums/admin_collections.internal.RequirementType.mdx) +- [ReturnStatus](../../internal/enums/admin_collections.internal.ReturnStatus.mdx) +- [ShippingOptionPriceType](../../internal/enums/admin_collections.internal.ShippingOptionPriceType.mdx) +- [ShippingProfileType](../../internal/enums/admin_collections.internal.ShippingProfileType.mdx) +- [SwapFulfillmentStatus](../../internal/enums/admin_collections.internal.SwapFulfillmentStatus.mdx) +- [SwapPaymentStatus](../../internal/enums/admin_collections.internal.SwapPaymentStatus.mdx) + +## Classes + +- [Address](../../internal/classes/admin_collections.internal.Address.mdx) +- [AdminDeleteProductsFromCollectionReq](../../internal/classes/admin_collections.internal.AdminDeleteProductsFromCollectionReq.mdx) +- [AdminGetCollectionsPaginationParams](../../internal/classes/admin_collections.internal.AdminGetCollectionsPaginationParams.mdx) +- [AdminGetCollectionsParams](../../internal/classes/admin_collections.internal.AdminGetCollectionsParams.mdx) +- [AdminPostCollectionsCollectionReq](../../internal/classes/admin_collections.internal.AdminPostCollectionsCollectionReq.mdx) +- [AdminPostCollectionsReq](../../internal/classes/admin_collections.internal.AdminPostCollectionsReq.mdx) +- [AdminPostProductsToCollectionReq](../../internal/classes/admin_collections.internal.AdminPostProductsToCollectionReq.mdx) +- [Cart](../../internal/classes/admin_collections.internal.Cart.mdx) +- [ClaimImage](../../internal/classes/admin_collections.internal.ClaimImage.mdx) +- [ClaimItem](../../internal/classes/admin_collections.internal.ClaimItem.mdx) +- [ClaimOrder](../../internal/classes/admin_collections.internal.ClaimOrder.mdx) +- [ClaimTag](../../internal/classes/admin_collections.internal.ClaimTag.mdx) +- [Country](../../internal/classes/admin_collections.internal.Country.mdx) +- [Currency](../../internal/classes/admin_collections.internal.Currency.mdx) +- [Customer](../../internal/classes/admin_collections.internal.Customer.mdx) +- [CustomerGroup](../../internal/classes/admin_collections.internal.CustomerGroup.mdx) +- [Discount](../../internal/classes/admin_collections.internal.Discount.mdx) +- [DiscountCondition](../../internal/classes/admin_collections.internal.DiscountCondition.mdx) +- [DiscountRule](../../internal/classes/admin_collections.internal.DiscountRule.mdx) +- [DraftOrder](../../internal/classes/admin_collections.internal.DraftOrder.mdx) +- [Fulfillment](../../internal/classes/admin_collections.internal.Fulfillment.mdx) +- [FulfillmentItem](../../internal/classes/admin_collections.internal.FulfillmentItem.mdx) +- [FulfillmentProvider](../../internal/classes/admin_collections.internal.FulfillmentProvider.mdx) +- [GiftCard](../../internal/classes/admin_collections.internal.GiftCard.mdx) +- [GiftCardTransaction](../../internal/classes/admin_collections.internal.GiftCardTransaction.mdx) +- [Image](../../internal/classes/admin_collections.internal.Image.mdx) +- [LineItem](../../internal/classes/admin_collections.internal.LineItem.mdx) +- [LineItemAdjustment](../../internal/classes/admin_collections.internal.LineItemAdjustment.mdx) +- [LineItemTaxLine](../../internal/classes/admin_collections.internal.LineItemTaxLine.mdx) +- [MoneyAmount](../../internal/classes/admin_collections.internal.MoneyAmount.mdx) +- [Order](../../internal/classes/admin_collections.internal.Order.mdx) +- [OrderEdit](../../internal/classes/admin_collections.internal.OrderEdit.mdx) +- [OrderItemChange](../../internal/classes/admin_collections.internal.OrderItemChange.mdx) +- [Payment](../../internal/classes/admin_collections.internal.Payment.mdx) +- [PaymentCollection](../../internal/classes/admin_collections.internal.PaymentCollection.mdx) +- [PaymentProvider](../../internal/classes/admin_collections.internal.PaymentProvider.mdx) +- [PaymentSession](../../internal/classes/admin_collections.internal.PaymentSession.mdx) +- [PriceList](../../internal/classes/admin_collections.internal.PriceList.mdx) +- [Product](../../internal/classes/admin_collections.internal.Product.mdx) +- [ProductCategory](../../internal/classes/admin_collections.internal.ProductCategory.mdx) +- [ProductCollection](../../internal/classes/admin_collections.internal.ProductCollection.mdx) +- [ProductOption](../../internal/classes/admin_collections.internal.ProductOption.mdx) +- [ProductOptionValue](../../internal/classes/admin_collections.internal.ProductOptionValue.mdx) +- [ProductTag](../../internal/classes/admin_collections.internal.ProductTag.mdx) +- [ProductType](../../internal/classes/admin_collections.internal.ProductType.mdx) +- [ProductVariant](../../internal/classes/admin_collections.internal.ProductVariant.mdx) +- [ProductVariantInventoryItem](../../internal/classes/admin_collections.internal.ProductVariantInventoryItem.mdx) +- [Refund](../../internal/classes/admin_collections.internal.Refund.mdx) +- [Region](../../internal/classes/admin_collections.internal.Region.mdx) +- [Return](../../internal/classes/admin_collections.internal.Return.mdx) +- [ReturnItem](../../internal/classes/admin_collections.internal.ReturnItem.mdx) +- [ReturnReason](../../internal/classes/admin_collections.internal.ReturnReason.mdx) +- [SalesChannel](../../internal/classes/admin_collections.internal.SalesChannel.mdx) +- [SalesChannelLocation](../../internal/classes/admin_collections.internal.SalesChannelLocation.mdx) +- [ShippingMethod](../../internal/classes/admin_collections.internal.ShippingMethod.mdx) +- [ShippingMethodTaxLine](../../internal/classes/admin_collections.internal.ShippingMethodTaxLine.mdx) +- [ShippingOption](../../internal/classes/admin_collections.internal.ShippingOption.mdx) +- [ShippingOptionRequirement](../../internal/classes/admin_collections.internal.ShippingOptionRequirement.mdx) +- [ShippingProfile](../../internal/classes/admin_collections.internal.ShippingProfile.mdx) +- [Swap](../../internal/classes/admin_collections.internal.Swap.mdx) +- [TaxLine](../../internal/classes/admin_collections.internal.TaxLine.mdx) +- [TaxProvider](../../internal/classes/admin_collections.internal.TaxProvider.mdx) +- [TaxRate](../../internal/classes/admin_collections.internal.TaxRate.mdx) +- [TrackingLink](../../internal/classes/admin_collections.internal.TrackingLink.mdx) + +## Interfaces + +- [Boolean](../../internal/interfaces/admin_collections.internal.Boolean.mdx) + +## Enumeration Members + +### ORDER\_EDIT + +• **ORDER\_EDIT**: ``"order_edit"`` + +## Type Aliases + +### AdminCollectionsListRes + +Ƭ **AdminCollectionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)[] } + +#### 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 + +___ + +### AdminCollectionsRes + +Ƭ **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 + + + +___ + +### AdminDeleteProductsFromCollectionRes + +Ƭ **AdminDeleteProductsFromCollectionRes**: `Object` + +#### Schema + +The ID of the collection + +#### Type declaration + + + +## Functions + +### Boolean + +▸ **Boolean**<`T`\>(`value?`): `boolean` + + + +#### Parameters + + + +#### Returns + +`boolean` + + diff --git a/www/apps/docs/content/references/js-client/admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx b/www/apps/docs/content/references/js-client/admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx new file mode 100644 index 0000000000..17fe6d7d08 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx @@ -0,0 +1,131 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminCurrenciesResource + +[admin/currencies](../../modules/admin_currencies.mdx).AdminCurrenciesResource + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesListRes`](../modules/admin_currencies.internal.mdx#admincurrencieslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesListRes`](../modules/admin_currencies.internal.mdx#admincurrencieslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the list of currencies as well as the pagination properties.", + "children": [ + { + "name": "AdminCurrenciesListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `currencies`: [`Currency`](../../internal/classes/admin_collections.internal.Currency.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +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. + +___ + +### update + +▸ **update**(`code`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesRes`](../modules/admin_currencies.internal.mdx#admincurrenciesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesRes`](../modules/admin_currencies.internal.mdx#admincurrenciesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated currency.", + "children": [ + { + "name": "AdminCurrenciesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### 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. diff --git a/www/apps/docs/content/references/js-client/admin_currencies/modules/admin_currencies.internal.mdx b/www/apps/docs/content/references/js-client/admin_currencies/modules/admin_currencies.internal.mdx new file mode 100644 index 0000000000..ce698edc19 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_currencies/modules/admin_currencies.internal.mdx @@ -0,0 +1,74 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +## Classes + +- [AdminGetCurrenciesParams](../../internal/classes/admin_currencies.internal.AdminGetCurrenciesParams.mdx) +- [AdminPostCurrenciesCurrencyReq](../../internal/classes/admin_currencies.internal.AdminPostCurrenciesCurrencyReq.mdx) +- [FindPaginationParams](../../internal/classes/admin_currencies.internal.FindPaginationParams.mdx) + +## Type Aliases + +### AdminCurrenciesListRes + +Ƭ **AdminCurrenciesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `currencies`: [`Currency`](../../internal/classes/admin_collections.internal.Currency.mdx)[] } + +#### 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 + +___ + +### AdminCurrenciesRes + +Ƭ **AdminCurrenciesRes**: `Object` + +#### Schema + +AdminCurrenciesRes +type: object +required: + - currency +properties: + currency: + description: Currency details. + $ref: "#/components/schemas/Currency" + +#### Type declaration + + diff --git a/www/apps/docs/content/references/js-client/admin_custom/classes/admin_custom.AdminCustomResource.mdx b/www/apps/docs/content/references/js-client/admin_custom/classes/admin_custom.AdminCustomResource.mdx new file mode 100644 index 0000000000..2458af3a4f --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_custom/classes/admin_custom.AdminCustomResource.mdx @@ -0,0 +1,224 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminCustomResource + +[admin/custom](../../modules/admin_custom.mdx).AdminCustomResource + +## Methods + +### delete + +▸ **delete**<`TResponse`\>(`path`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### get + +▸ **get**<`TQuery`, `TResponse`\>(`path`, `query?`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\> + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "TResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### post + +▸ **post**<`TPayload`, `TResponse`\>(`path`, `payload?`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\> + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "TResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_custom/modules/admin_custom.internal.mdx b/www/apps/docs/content/references/js-client/admin_custom/modules/admin_custom.internal.mdx new file mode 100644 index 0000000000..5c1266c0c9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_custom/modules/admin_custom.internal.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +## Interfaces + +- [RequestOptions](../../internal/interfaces/admin_custom.internal.RequestOptions.mdx) diff --git a/www/apps/docs/content/references/js-client/admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx b/www/apps/docs/content/references/js-client/admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx new file mode 100644 index 0000000000..22d6d3b58a --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx @@ -0,0 +1,473 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminCustomerGroupsResource + +[admin/customer-groups](../../modules/admin_customer_groups.mdx).AdminCustomerGroupsResource + +## Methods + +### addCustomers + +▸ **addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> + +Add multiple customers to a customer group. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminCustomerGroupsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> + +Create a customer group. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminCustomerGroupsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +Deletes a customer group. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupslistres)\> + +Lists customer groups. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminCustomerGroupsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../../internal/classes/admin_collections.internal.CustomerGroup.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### listCustomers + +▸ **listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersListRes`](../../admin_customers/modules/admin_customers.internal.mdx#admincustomerslistres)\> + +List and count customers that belong to provided customer groups. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersListRes`](../../admin_customers/modules/admin_customers.internal.mdx#admincustomerslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminCustomersListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customers`: [`Customer`](../../internal/classes/admin_collections.internal.Customer.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeCustomers + +▸ **removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> + +Remove multiple customers from a customer group. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminCustomerGroupsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> + +Retrieves a customer group. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminCustomerGroupsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> + +Updates a customer group + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminCustomerGroupsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_customer_groups/modules/admin_customer_groups.internal.mdx b/www/apps/docs/content/references/js-client/admin_customer_groups/modules/admin_customer_groups.internal.mdx new file mode 100644 index 0000000000..19f2d00161 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_customer_groups/modules/admin_customer_groups.internal.mdx @@ -0,0 +1,81 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +## Classes + +- [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../../internal/classes/admin_customer_groups.internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.mdx) +- [AdminGetCustomerGroupsGroupParams](../../internal/classes/admin_customer_groups.internal.AdminGetCustomerGroupsGroupParams.mdx) +- [AdminGetCustomerGroupsParams](../../internal/classes/admin_customer_groups.internal.AdminGetCustomerGroupsParams.mdx) +- [AdminPostCustomerGroupsGroupCustomersBatchReq](../../internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsGroupCustomersBatchReq.mdx) +- [AdminPostCustomerGroupsGroupReq](../../internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsGroupReq.mdx) +- [AdminPostCustomerGroupsReq](../../internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsReq.mdx) +- [CustomerGroupsBatchCustomer](../../internal/classes/admin_customer_groups.internal.CustomerGroupsBatchCustomer.mdx) +- [FilterableCustomerGroupProps](../../internal/classes/admin_customer_groups.internal.FilterableCustomerGroupProps.mdx) +- [FindParams](../../internal/classes/admin_customer_groups.internal.FindParams.mdx) +- [StringComparisonOperator](../../internal/classes/admin_customer_groups.internal.StringComparisonOperator.mdx) + +## Type Aliases + +### AdminCustomerGroupsListRes + +Ƭ **AdminCustomerGroupsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../../internal/classes/admin_collections.internal.CustomerGroup.mdx)[] } + +#### 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 + +___ + +### AdminCustomerGroupsRes + +Ƭ **AdminCustomerGroupsRes**: `Object` + +#### Schema + +AdminCustomerGroupsRes +type: object +required: + - customer_group +properties: + customer_group: + description: Customer group details. + $ref: "#/components/schemas/CustomerGroup" + +#### Type declaration + + diff --git a/www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx b/www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx new file mode 100644 index 0000000000..81bf983e3a --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx @@ -0,0 +1,229 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminCustomersResource + +[admin/customers](../../modules/admin_customers.mdx).AdminCustomersResource + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\> + +Creates a customer + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminCustomersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersListRes`](../modules/admin_customers.internal.mdx#admincustomerslistres)\> + +Lists customers + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersListRes`](../modules/admin_customers.internal.mdx#admincustomerslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminCustomersListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customers`: [`Customer`](../../internal/classes/admin_collections.internal.Customer.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\> + +Retrieves a customer + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminCustomersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\> + +Updates a customer + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminCustomersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_customers/modules/admin_customers.internal.mdx b/www/apps/docs/content/references/js-client/admin_customers/modules/admin_customers.internal.mdx new file mode 100644 index 0000000000..e44bb3b237 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_customers/modules/admin_customers.internal.mdx @@ -0,0 +1,48 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +## Classes + +- [AdminGetCustomersParams](../../internal/classes/admin_customers.internal.AdminGetCustomersParams.mdx) +- [AdminListCustomerSelector](../../internal/classes/admin_customers.internal.AdminListCustomerSelector.mdx) +- [AdminPostCustomersCustomerReq](../../internal/classes/admin_customers.internal.AdminPostCustomersCustomerReq.mdx) +- [AdminPostCustomersReq](../../internal/classes/admin_customers.internal.AdminPostCustomersReq.mdx) +- [Group](../../internal/classes/admin_customers.internal.Group.mdx) + +## Type Aliases + +### AdminCustomersListRes + +Ƭ **AdminCustomersListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customers`: [`Customer`](../../internal/classes/admin_collections.internal.Customer.mdx)[] } + +#### Schema + +An array of customer details. + +___ + +### AdminCustomersRes + +Ƭ **AdminCustomersRes**: `Object` + +#### Schema + +Customer details. + +#### Type declaration + + diff --git a/www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx b/www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx new file mode 100644 index 0000000000..a143f47ad0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx @@ -0,0 +1,1033 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDiscountsResource + +[admin/discounts](../../modules/admin_discounts.mdx).AdminDiscountsResource + +## Methods + +### addConditionResourceBatch + +▸ **addConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Add a batch of items to a discount condition + +___ + +### addRegion + +▸ **addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Adds region to discount + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Creates discounts + +___ + +### createCondition + +▸ **createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +creates a discount condition + +___ + +### createDynamicCode + +▸ **createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Creates a dynamic discount code + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Deletes a discount + +___ + +### deleteCondition + +▸ **deleteCondition**(`discountId`, `conditionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Removes a condition from a discount + +___ + +### deleteConditionResourceBatch + +▸ **deleteConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Delete a batch of items from a discount condition + +___ + +### deleteDynamicCode + +▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Deletes a dynamic discount + +___ + +### getCondition + +▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountConditionsRes`](../modules/admin_discounts.internal.mdx#admindiscountconditionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountConditionsRes`](../modules/admin_discounts.internal.mdx#admindiscountconditionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountConditionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Gets a condition from a discount + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsListRes`](../modules/admin_discounts.internal.mdx#admindiscountslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsListRes`](../modules/admin_discounts.internal.mdx#admindiscountslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `discounts`: [`Discount`](../../internal/classes/admin_collections.internal.Discount.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Lists discounts + +___ + +### removeRegion + +▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Removes a region from a discount + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a discount + +___ + +### retrieveByCode + +▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a discount by code + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Updates discount + +___ + +### updateCondition + +▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDiscountsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Updates a discount condition diff --git a/www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx b/www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx new file mode 100644 index 0000000000..cdac5d7c4a --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx @@ -0,0 +1,14357 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +## Namespaces + +- [EventEmitter](../../internal/modules/admin_discounts.internal.EventEmitter.mdx) +- [internal](../../internal/modules/admin_discounts.internal.internal.mdx) +- [internal](../../internal/modules/admin_discounts.internal.internal-1.mdx) +- [internal](../../internal/modules/admin_discounts.internal.internal-2.mdx) +- [internal](../../internal/modules/admin_discounts.internal.internal-3.mdx) +- [internal](../../internal/modules/admin_discounts.internal.internal-4.mdx) + +## Enumerations + +- [DefaultPriceType](../../internal/enums/admin_discounts.internal.DefaultPriceType.mdx) +- [DiscountConditionJoinTableForeignKey](../../internal/enums/admin_discounts.internal.DiscountConditionJoinTableForeignKey.mdx) +- [FulfillmentStatus](../../internal/enums/admin_discounts.internal.FulfillmentStatus.mdx) +- [MODULE\_RESOURCE\_TYPE](../../internal/enums/admin_discounts.internal.MODULE_RESOURCE_TYPE.mdx) +- [OrderStatus](../../internal/enums/admin_discounts.internal.OrderStatus.mdx) +- [PaymentStatus](../../internal/enums/admin_discounts.internal.PaymentStatus.mdx) + +## Classes + +- [AbstractEventBusModuleService](../../internal/classes/admin_discounts.internal.AbstractEventBusModuleService.mdx) +- [AbstractSearchService](../../internal/classes/admin_discounts.internal.AbstractSearchService.mdx) +- [AdditionalItem](../../internal/classes/admin_discounts.internal.AdditionalItem.mdx) +- [AdditionalItem](../../internal/classes/admin_discounts.internal.AdditionalItem-1.mdx) +- [AdditionalItem](../../internal/classes/admin_discounts.internal.AdditionalItem-2.mdx) +- [AdminCreateCondition](../../internal/classes/admin_discounts.internal.AdminCreateCondition.mdx) +- [AdminDeleteDiscountsDiscountConditionsConditionBatchReq](../../internal/classes/admin_discounts.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.mdx) +- [AdminGetDiscountsDiscountConditionsConditionParams](../../internal/classes/admin_discounts.internal.AdminGetDiscountsDiscountConditionsConditionParams.mdx) +- [AdminGetDiscountsDiscountRuleParams](../../internal/classes/admin_discounts.internal.AdminGetDiscountsDiscountRuleParams.mdx) +- [AdminGetDiscountsParams](../../internal/classes/admin_discounts.internal.AdminGetDiscountsParams.mdx) +- [AdminListOrdersSelector](../../internal/classes/admin_discounts.internal.AdminListOrdersSelector.mdx) +- [AdminPostDiscountsDiscountConditions](../../internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditions.mdx) +- [AdminPostDiscountsDiscountConditionsCondition](../../internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsCondition.mdx) +- [AdminPostDiscountsDiscountConditionsConditionBatchParams](../../internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionBatchParams.mdx) +- [AdminPostDiscountsDiscountConditionsConditionBatchReq](../../internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionBatchReq.mdx) +- [AdminPostDiscountsDiscountConditionsConditionParams](../../internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionParams.mdx) +- [AdminPostDiscountsDiscountConditionsParams](../../internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsParams.mdx) +- [AdminPostDiscountsDiscountDynamicCodesReq](../../internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountDynamicCodesReq.mdx) +- [AdminPostDiscountsDiscountReq](../../internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountReq.mdx) +- [AdminPostDiscountsDiscountRule](../../internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountRule.mdx) +- [AdminPostDiscountsReq](../../internal/classes/admin_discounts.internal.AdminPostDiscountsReq.mdx) +- [AdminPriceSelectionParams](../../internal/classes/admin_discounts.internal.AdminPriceSelectionParams.mdx) +- [AdminProductCategoriesReqBase](../../internal/classes/admin_discounts.internal.AdminProductCategoriesReqBase.mdx) +- [AdminUpdateDiscountRule](../../internal/classes/admin_discounts.internal.AdminUpdateDiscountRule.mdx) +- [AdminUpsertCondition](../../internal/classes/admin_discounts.internal.AdminUpsertCondition.mdx) +- [AdminUpsertConditionsReq](../../internal/classes/admin_discounts.internal.AdminUpsertConditionsReq.mdx) +- [Blob](../../internal/classes/admin_discounts.internal.Blob.mdx) +- [CustomShippingOption](../../internal/classes/admin_discounts.internal.CustomShippingOption.mdx) +- [CustomerGroup](../../internal/classes/admin_discounts.internal.CustomerGroup.mdx) +- [CustomerGroup](../../internal/classes/admin_discounts.internal.CustomerGroup-1.mdx) +- [CustomerGroupUpdate](../../internal/classes/admin_discounts.internal.CustomerGroupUpdate.mdx) +- [Discount](../../internal/classes/admin_discounts.internal.Discount.mdx) +- [Discount](../../internal/classes/admin_discounts.internal.Discount-1.mdx) +- [Discount](../../internal/classes/admin_discounts.internal.Discount-2.mdx) +- [Discount](../../internal/classes/admin_discounts.internal.Discount-3.mdx) +- [Duplex](../../internal/classes/admin_discounts.internal.Duplex.mdx) +- [EventEmitter](../../internal/classes/admin_discounts.internal.EventEmitter-1.mdx) +- [FilterableCartProps](../../internal/classes/admin_discounts.internal.FilterableCartProps.mdx) +- [FilterableDiscountProps](../../internal/classes/admin_discounts.internal.FilterableDiscountProps.mdx) +- [FilterableLineItemAdjustmentProps](../../internal/classes/admin_discounts.internal.FilterableLineItemAdjustmentProps.mdx) +- [FilterableProductProps](../../internal/classes/admin_discounts.internal.FilterableProductProps.mdx) +- [FilterableProductVariantProps](../../internal/classes/admin_discounts.internal.FilterableProductVariantProps.mdx) +- [FlagRouter](../../internal/classes/admin_discounts.internal.FlagRouter.mdx) +- [FulfillmentService](../../internal/classes/admin_discounts.internal.FulfillmentService.mdx) +- [GiftCard](../../internal/classes/admin_discounts.internal.GiftCard.mdx) +- [GiftCard](../../internal/classes/admin_discounts.internal.GiftCard-1.mdx) +- [Image](../../internal/classes/admin_discounts.internal.Image.mdx) +- [Item](../../internal/classes/admin_discounts.internal.Item.mdx) +- [Item](../../internal/classes/admin_discounts.internal.Item-1.mdx) +- [Item](../../internal/classes/admin_discounts.internal.Item-2.mdx) +- [Item](../../internal/classes/admin_discounts.internal.Item-3.mdx) +- [Item](../../internal/classes/admin_discounts.internal.Item-4.mdx) +- [Item](../../internal/classes/admin_discounts.internal.Item-5.mdx) +- [Item](../../internal/classes/admin_discounts.internal.Item-6.mdx) +- [MedusaError](../../internal/classes/admin_discounts.internal.MedusaError.mdx) +- [NotificationProvider](../../internal/classes/admin_discounts.internal.NotificationProvider.mdx) +- [OptionRequirement](../../internal/classes/admin_discounts.internal.OptionRequirement.mdx) +- [OptionRequirement](../../internal/classes/admin_discounts.internal.OptionRequirement-1.mdx) +- [OrdersReturnItem](../../internal/classes/admin_discounts.internal.OrdersReturnItem.mdx) +- [PassThrough](../../internal/classes/admin_discounts.internal.PassThrough.mdx) +- [PaymentMethod](../../internal/classes/admin_discounts.internal.PaymentMethod.mdx) +- [PaymentService](../../internal/classes/admin_discounts.internal.PaymentService.mdx) +- [PriceSelectionParams](../../internal/classes/admin_discounts.internal.PriceSelectionParams.mdx) +- [ProductBatchProductCategory](../../internal/classes/admin_discounts.internal.ProductBatchProductCategory.mdx) +- [ProductBatchSalesChannel](../../internal/classes/admin_discounts.internal.ProductBatchSalesChannel.mdx) +- [ProductOptionReq](../../internal/classes/admin_discounts.internal.ProductOptionReq.mdx) +- [ProductProductCategoryReq](../../internal/classes/admin_discounts.internal.ProductProductCategoryReq.mdx) +- [ProductSalesChannelReq](../../internal/classes/admin_discounts.internal.ProductSalesChannelReq.mdx) +- [ProductTagReq](../../internal/classes/admin_discounts.internal.ProductTagReq.mdx) +- [ProductTypeReq](../../internal/classes/admin_discounts.internal.ProductTypeReq.mdx) +- [ProductVariantOptionReq](../../internal/classes/admin_discounts.internal.ProductVariantOptionReq.mdx) +- [ProductVariantOptionReq](../../internal/classes/admin_discounts.internal.ProductVariantOptionReq-1.mdx) +- [ProductVariantOptionReq](../../internal/classes/admin_discounts.internal.ProductVariantOptionReq-2.mdx) +- [ProductVariantOptionReq](../../internal/classes/admin_discounts.internal.ProductVariantOptionReq-3.mdx) +- [ProductVariantPricesCreateReq](../../internal/classes/admin_discounts.internal.ProductVariantPricesCreateReq.mdx) +- [ProductVariantPricesUpdateReq](../../internal/classes/admin_discounts.internal.ProductVariantPricesUpdateReq.mdx) +- [ProductVariantReq](../../internal/classes/admin_discounts.internal.ProductVariantReq.mdx) +- [ProductVariantReq](../../internal/classes/admin_discounts.internal.ProductVariantReq-1.mdx) +- [Readable](../../internal/classes/admin_discounts.internal.Readable.mdx) +- [ReadableBase](../../internal/classes/admin_discounts.internal.ReadableBase.mdx) +- [ReturnItem](../../internal/classes/admin_discounts.internal.ReturnItem.mdx) +- [ReturnShipping](../../internal/classes/admin_discounts.internal.ReturnShipping.mdx) +- [ReturnShipping](../../internal/classes/admin_discounts.internal.ReturnShipping-1.mdx) +- [ReturnShipping](../../internal/classes/admin_discounts.internal.ReturnShipping-2.mdx) +- [ReturnShipping](../../internal/classes/admin_discounts.internal.ReturnShipping-3.mdx) +- [ShippingMethod](../../internal/classes/admin_discounts.internal.ShippingMethod.mdx) +- [ShippingMethod](../../internal/classes/admin_discounts.internal.ShippingMethod-1.mdx) +- [ShippingMethod](../../internal/classes/admin_discounts.internal.ShippingMethod-2.mdx) +- [ShippingMethod](../../internal/classes/admin_discounts.internal.ShippingMethod-3.mdx) +- [StockLocationAddress](../../internal/classes/admin_discounts.internal.StockLocationAddress.mdx) +- [StockLocationAddress](../../internal/classes/admin_discounts.internal.StockLocationAddress-1.mdx) +- [Stream](../../internal/classes/admin_discounts.internal.Stream.mdx) +- [Tag](../../internal/classes/admin_discounts.internal.Tag.mdx) +- [Transform](../../internal/classes/admin_discounts.internal.Transform.mdx) +- [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx) +- [internal](../../internal/classes/admin_discounts.internal.internal-5.mdx) + +## Interfaces + +- [ArrayBufferView](../../internal/interfaces/admin_discounts.internal.ArrayBufferView.mdx) +- [ArrayLike](../../internal/interfaces/admin_discounts.internal.ArrayLike.mdx) +- [AsyncGenerator](../../internal/interfaces/admin_discounts.internal.AsyncGenerator.mdx) +- [AsyncGeneratorFunction](../../internal/interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx) +- [AsyncIterable](../../internal/interfaces/admin_discounts.internal.AsyncIterable.mdx) +- [AsyncIterableIterator](../../internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx) +- [AsyncIterator](../../internal/interfaces/admin_discounts.internal.AsyncIterator.mdx) +- [BlobOptions](../../internal/interfaces/admin_discounts.internal.BlobOptions.mdx) +- [Buffer](../../internal/interfaces/admin_discounts.internal.Buffer.mdx) +- [BufferConstructor](../../internal/interfaces/admin_discounts.internal.BufferConstructor.mdx) +- [CallSite](../../internal/interfaces/admin_discounts.internal.CallSite.mdx) +- [CreateNoteInput](../../internal/interfaces/admin_discounts.internal.CreateNoteInput.mdx) +- [CreateUserInput](../../internal/interfaces/admin_discounts.internal.CreateUserInput.mdx) +- [DuplexOptions](../../internal/interfaces/admin_discounts.internal.DuplexOptions.mdx) +- [ErrnoException](../../internal/interfaces/admin_discounts.internal.ErrnoException.mdx) +- [Error](../../internal/interfaces/admin_discounts.internal.Error.mdx) +- [EventEmitter](../../internal/interfaces/admin_discounts.internal.EventEmitter-2.mdx) +- [EventEmitterOptions](../../internal/interfaces/admin_discounts.internal.EventEmitterOptions.mdx) +- [FindConfig](../../internal/interfaces/admin_discounts.internal.FindConfig.mdx) +- [ICacheService](../../internal/interfaces/admin_discounts.internal.ICacheService.mdx) +- [IEventBusModuleService](../../internal/interfaces/admin_discounts.internal.IEventBusModuleService.mdx) +- [IEventBusService](../../internal/interfaces/admin_discounts.internal.IEventBusService.mdx) +- [IFlagRouter](../../internal/interfaces/admin_discounts.internal.IFlagRouter.mdx) +- [IInventoryService](../../internal/interfaces/admin_discounts.internal.IInventoryService.mdx) +- [ISearchService](../../internal/interfaces/admin_discounts.internal.ISearchService.mdx) +- [IStockLocationService](../../internal/interfaces/admin_discounts.internal.IStockLocationService.mdx) +- [ITransactionBaseService](../../internal/interfaces/admin_discounts.internal.ITransactionBaseService.mdx) +- [Iterable](../../internal/interfaces/admin_discounts.internal.Iterable.mdx) +- [IterableIterator](../../internal/interfaces/admin_discounts.internal.IterableIterator.mdx) +- [Iterator](../../internal/interfaces/admin_discounts.internal.Iterator.mdx) +- [IteratorReturnResult](../../internal/interfaces/admin_discounts.internal.IteratorReturnResult.mdx) +- [IteratorYieldResult](../../internal/interfaces/admin_discounts.internal.IteratorYieldResult.mdx) +- [JoinerServiceConfig](../../internal/interfaces/admin_discounts.internal.JoinerServiceConfig.mdx) +- [JoinerServiceConfigAlias](../../internal/interfaces/admin_discounts.internal.JoinerServiceConfigAlias.mdx) +- [Logger](../../internal/interfaces/admin_discounts.internal.Logger.mdx) +- [NumericalComparisonOperator](../../internal/interfaces/admin_discounts.internal.NumericalComparisonOperator.mdx) +- [Object](../../internal/interfaces/admin_discounts.internal.Object.mdx) +- [PromiseLike](../../internal/interfaces/admin_discounts.internal.PromiseLike.mdx) +- [QueuingStrategy](../../internal/interfaces/admin_discounts.internal.QueuingStrategy.mdx) +- [QueuingStrategySize](../../internal/interfaces/admin_discounts.internal.QueuingStrategySize.mdx) +- [ReadWriteStream](../../internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx) +- [ReadableByteStreamController](../../internal/interfaces/admin_discounts.internal.ReadableByteStreamController.mdx) +- [ReadableByteStreamControllerCallback](../../internal/interfaces/admin_discounts.internal.ReadableByteStreamControllerCallback.mdx) +- [ReadableStream](../../internal/interfaces/admin_discounts.internal.ReadableStream.mdx) +- [ReadableStream](../../internal/interfaces/admin_discounts.internal.ReadableStream-1.mdx) +- [ReadableStreamDefaultController](../../internal/interfaces/admin_discounts.internal.ReadableStreamDefaultController.mdx) +- [ReadableStreamDefaultReadDoneResult](../../internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadDoneResult.mdx) +- [ReadableStreamDefaultReadValueResult](../../internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadValueResult.mdx) +- [ReadableStreamDefaultReader](../../internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReader.mdx) +- [ReadableStreamErrorCallback](../../internal/interfaces/admin_discounts.internal.ReadableStreamErrorCallback.mdx) +- [ReadableStreamGenericReader](../../internal/interfaces/admin_discounts.internal.ReadableStreamGenericReader.mdx) +- [ReadableWritablePair](../../internal/interfaces/admin_discounts.internal.ReadableWritablePair.mdx) +- [SharedArrayBuffer](../../internal/interfaces/admin_discounts.internal.SharedArrayBuffer.mdx) +- [SharedArrayBufferConstructor](../../internal/interfaces/admin_discounts.internal.SharedArrayBufferConstructor.mdx) +- [StaticEventEmitterOptions](../../internal/interfaces/admin_discounts.internal.StaticEventEmitterOptions.mdx) +- [StreamPipeOptions](../../internal/interfaces/admin_discounts.internal.StreamPipeOptions.mdx) +- [StringComparisonOperator](../../internal/interfaces/admin_discounts.internal.StringComparisonOperator.mdx) +- [TransformOptions](../../internal/interfaces/admin_discounts.internal.TransformOptions.mdx) +- [UnderlyingByteSource](../../internal/interfaces/admin_discounts.internal.UnderlyingByteSource.mdx) +- [UnderlyingSink](../../internal/interfaces/admin_discounts.internal.UnderlyingSink.mdx) +- [UnderlyingSinkAbortCallback](../../internal/interfaces/admin_discounts.internal.UnderlyingSinkAbortCallback.mdx) +- [UnderlyingSinkCloseCallback](../../internal/interfaces/admin_discounts.internal.UnderlyingSinkCloseCallback.mdx) +- [UnderlyingSinkStartCallback](../../internal/interfaces/admin_discounts.internal.UnderlyingSinkStartCallback.mdx) +- [UnderlyingSinkWriteCallback](../../internal/interfaces/admin_discounts.internal.UnderlyingSinkWriteCallback.mdx) +- [UnderlyingSource](../../internal/interfaces/admin_discounts.internal.UnderlyingSource.mdx) +- [UnderlyingSourceCancelCallback](../../internal/interfaces/admin_discounts.internal.UnderlyingSourceCancelCallback.mdx) +- [UnderlyingSourcePullCallback](../../internal/interfaces/admin_discounts.internal.UnderlyingSourcePullCallback.mdx) +- [UnderlyingSourceStartCallback](../../internal/interfaces/admin_discounts.internal.UnderlyingSourceStartCallback.mdx) +- [UpdateUserInput](../../internal/interfaces/admin_discounts.internal.UpdateUserInput.mdx) +- [WritableStream](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) +- [WritableStream](../../internal/interfaces/admin_discounts.internal.WritableStream-1.mdx) +- [WritableStreamDefaultController](../../internal/interfaces/admin_discounts.internal.WritableStreamDefaultController.mdx) +- [WritableStreamDefaultWriter](../../internal/interfaces/admin_discounts.internal.WritableStreamDefaultWriter.mdx) +- [\_DOMEventTarget](../../internal/interfaces/admin_discounts.internal._DOMEventTarget.mdx) +- [\_NodeEventTarget](../../internal/interfaces/admin_discounts.internal._NodeEventTarget.mdx) + +## References + +### Abortable + +Re-exports [Abortable](../../EventEmitter/interfaces/admin_discounts.internal.EventEmitter.Abortable.mdx) + +___ + +### ReadableOptions + +Re-exports [ReadableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx) + +___ + +### WritableOptions + +Re-exports [WritableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx) + +## Enumeration Members + +### DEFAULT + +• **DEFAULT**: ``"default"`` + +___ + +### EXTERNAL + +• **EXTERNAL**: ``"external"`` + +___ + +### INTERNAL + +• **INTERNAL**: ``"internal"`` + +## Type Aliases + +### AddOrderEditLineItemInput + +Ƭ **AddOrderEditLineItemInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### AdjustmentContext + +Ƭ **AdjustmentContext**: `Object` + +#### Type declaration + + + +___ + +### AdminDiscountConditionsRes + +Ƭ **AdminDiscountConditionsRes**: `Object` + +#### Schema + +Discount condition details. + +#### Type declaration + + + +___ + +### AdminDiscountsListRes + +Ƭ **AdminDiscountsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `discounts`: [`Discount`](../../internal/classes/admin_collections.internal.Discount.mdx)[] } + +#### 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 + +___ + +### AdminDiscountsRes + +Ƭ **AdminDiscountsRes**: `Object` + +#### Schema + +Discount details. + +#### Type declaration + + + +___ + +### AllocationMapOptions + +Ƭ **AllocationMapOptions**: `Object` + +#### Type declaration + + + +___ + +### ArrayBufferLike + +Ƭ **ArrayBufferLike**: `ArrayBufferTypes`[keyof `ArrayBufferTypes`] + +___ + +### ArrayBufferView + +Ƭ **ArrayBufferView**: [`TypedArray`](admin_discounts.internal.mdx#typedarray) \| `DataView` + +___ + +### AuthenticateResult + +Ƭ **AuthenticateResult**: `Object` + +#### Type declaration + + + +___ + +### AvailabilityContext + +Ƭ **AvailabilityContext**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "variantInventoryMap", + "type": "`Map`<`string`, [`ProductVariantInventoryItem`](../../internal/classes/admin_collections.internal.ProductVariantInventoryItem.mdx)[]\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### BinaryLike + +Ƭ **BinaryLike**: `string` \| [`ArrayBufferView`](admin_discounts.internal.mdx#arraybufferview) + +___ + +### BufferEncoding + +Ƭ **BufferEncoding**: ``"ascii"`` \| ``"utf8"`` \| ``"utf-8"`` \| ``"utf16le"`` \| ``"ucs2"`` \| ``"ucs-2"`` \| ``"base64"`` \| ``"base64url"`` \| ``"latin1"`` \| ``"binary"`` \| ``"hex"`` + +___ + +### CalculateOptionPriceInput + +Ƭ **CalculateOptionPriceInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CalculationContextData + +Ƭ **CalculationContextData**: `Object` + +#### Type declaration + + + +___ + +### CalculationContextOptions + +Ƭ **CalculationContextOptions**: `Object` + +#### Type declaration + + + +___ + +### CartCreateProps + +Ƭ **CartCreateProps**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "`object`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](../../internal/classes/admin_discounts.internal.Discount-3.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](../../internal/classes/admin_discounts.internal.GiftCard-1.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](../../internal/classes/admin_collections.internal.Region.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Partial`](admin_discounts.internal.mdx#partial)<[`AddressPayload`](../../internal/classes/addresses.internal.AddressPayload.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../../internal/enums/admin_collections.internal.CartType.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CartUpdateProps + +Ƭ **CartUpdateProps**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`AddressPayload`](../../internal/classes/addresses.internal.AddressPayload.mdx) \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CategoryQueryParams + +Ƭ **CategoryQueryParams**: `Object` + +#### Type declaration + + + +___ + +### ClaimTypeValue + +Ƭ **ClaimTypeValue**: \`${ClaimType}\` + +___ + +### ConfigModule + +Ƭ **ConfigModule**: `Object` + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "modules", + "type": "Record<`string`, ``false`` \\| `string` \\| [`Partial`](admin_discounts.internal.mdx#partial)<[`InternalModuleDeclaration`](admin_discounts.internal.mdx#internalmoduledeclaration) \\| [`ExternalModuleDeclaration`](admin_discounts.internal.mdx#externalmoduledeclaration)\\>\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "plugins", + "type": "({ `options`: Record<`string`, `unknown`\\> ; `resolve`: `string` } \\| `string`)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "projectConfig", + "type": "[`ProjectConfigOptions`](admin_discounts.internal.mdx#projectconfigoptions)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### Constructor + +Ƭ **Constructor**<`T`\>: `Object` + +#### Type parameters + + + +___ + +### CreateAnalyticsConfig + +Ƭ **CreateAnalyticsConfig**: `Object` + +#### Type declaration + + + +___ + +### CreateClaimInput + +Ƭ **CreateClaimInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](../../internal/classes/admin_collections.internal.Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "return_location_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "return_shipping", + "type": "[`CreateClaimReturnShippingInput`](admin_discounts.internal.mdx#createclaimreturnshippinginput)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`AddressPayload`](../../internal/classes/addresses.internal.AddressPayload.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`CreateClaimShippingMethodInput`](admin_discounts.internal.mdx#createclaimshippingmethodinput)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimTypeValue`](admin_discounts.internal.mdx#claimtypevalue)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateClaimItemAdditionalItemInput + +Ƭ **CreateClaimItemAdditionalItemInput**: `Object` + +#### Type declaration + + + +___ + +### CreateClaimItemInput + +Ƭ **CreateClaimItemInput**: `Object` + +#### Type declaration + + + +___ + +### CreateClaimReturnShippingInput + +Ƭ **CreateClaimReturnShippingInput**: `Object` + +#### Type declaration + + + +___ + +### CreateClaimShippingMethodInput + +Ƭ **CreateClaimShippingMethodInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateCustomShippingOptionInput + +Ƭ **CreateCustomShippingOptionInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateCustomerInput + +Ƭ **CreateCustomerInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "password", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateDiscountInput + +Ƭ **CreateDiscountInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "`string`[] \\| [`Region`](../../internal/classes/admin_collections.internal.Region.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`CreateDiscountRuleInput`](admin_discounts.internal.mdx#creatediscountruleinput)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateDiscountRuleInput + +Ƭ **CreateDiscountRuleInput**: `Object` + +#### Type declaration + + + +___ + +### CreateDynamicDiscountInput + +Ƭ **CreateDynamicDiscountInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateFulfillmentOrder + +Ƭ **CreateFulfillmentOrder**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`ClaimOrder`](../../internal/classes/admin_collections.internal.ClaimOrder.mdx), ``"beforeInsert"``\> & { `billing_address`: [`Address`](../../internal/classes/admin_collections.internal.Address.mdx) ; `currency_code`: `string` ; `discounts`: [`Discount`](../../internal/classes/admin_collections.internal.Discount.mdx)[] ; `display_id`: `number` ; `email?`: `string` ; `is_claim?`: `boolean` ; `is_swap?`: `boolean` ; `items`: [`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)[] ; `no_notification`: `boolean` ; `payments`: [`Payment`](../../internal/classes/admin_collections.internal.Payment.mdx)[] ; `region?`: [`Region`](../../internal/classes/admin_collections.internal.Region.mdx) ; `region_id`: `string` ; `shipping_methods`: [`ShippingMethod`](../../internal/classes/admin_collections.internal.ShippingMethod.mdx)[] ; `tax_rate`: `number` \| ``null`` } + +___ + +### CreateGiftCardInput + +Ƭ **CreateGiftCardInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateGiftCardTransactionInput + +Ƭ **CreateGiftCardTransactionInput**: `Object` + +#### Type declaration + + + +___ + +### CreateIdempotencyKeyInput + +Ƭ **CreateIdempotencyKeyInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "request_path", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateInventoryItemInput + +Ƭ **CreateInventoryItemInput**: `Object` + +#### Type declaration + + \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requires_shipping", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateInventoryLevelInput + +Ƭ **CreateInventoryLevelInput**: `Object` + +#### Type declaration + + + +___ + +### CreateOauthInput + +Ƭ **CreateOauthInput**: `Object` + +#### Type declaration + + + +___ + +### CreateOrderEditInput + +Ƭ **CreateOrderEditInput**: `Object` + +#### Type declaration + + + +___ + +### CreateOrderEditItemChangeInput + +Ƭ **CreateOrderEditItemChangeInput**: `Object` + +#### Type declaration + + + +___ + +### CreatePaymentCollectionInput + +Ƭ **CreatePaymentCollectionInput**: `Object` + +#### Type declaration + + + +___ + +### CreatePaymentInput + +Ƭ **CreatePaymentInput**: `Object` + +#### Type declaration + + + +___ + +### CreateProductCategoryInput + +Ƭ **CreateProductCategoryInput**: [`ProductCategoryInput`](admin_discounts.internal.mdx#productcategoryinput) & { `name`: `string` } + +___ + +### CreateProductCollection + +Ƭ **CreateProductCollection**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateProductInput + +Ƭ **CreateProductInput**: `Object` + +Service Level DTOs + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`CreateProductProductOption`](admin_discounts.internal.mdx#createproductproductoption)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`CreateProductProductSalesChannelInput`](admin_discounts.internal.mdx#createproductproductsaleschannelinput)[] \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../../internal/enums/admin_collections.internal.ProductStatus.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`CreateProductProductTagInput`](admin_discounts.internal.mdx#createproductproducttaginput)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CreateProductProductTypeInput`](admin_discounts.internal.mdx#createproductproducttypeinput)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`CreateProductProductVariantInput`](admin_discounts.internal.mdx#createproductproductvariantinput)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateProductProductCategoryInput + +Ƭ **CreateProductProductCategoryInput**: `Object` + +#### Type declaration + + + +___ + +### CreateProductProductOption + +Ƭ **CreateProductProductOption**: `Object` + +#### Type declaration + + + +___ + +### CreateProductProductSalesChannelInput + +Ƭ **CreateProductProductSalesChannelInput**: `Object` + +#### Type declaration + + + +___ + +### CreateProductProductTagInput + +Ƭ **CreateProductProductTagInput**: `Object` + +#### Type declaration + + + +___ + +### CreateProductProductTypeInput + +Ƭ **CreateProductProductTypeInput**: `Object` + +#### Type declaration + + + +___ + +### CreateProductProductVariantInput + +Ƭ **CreateProductProductVariantInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "{ `value`: `string` }[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`CreateProductProductVariantPriceInput`](admin_discounts.internal.mdx#createproductproductvariantpriceinput)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateProductProductVariantPriceInput + +Ƭ **CreateProductProductVariantPriceInput**: `Object` + +#### Type declaration + + + +___ + +### CreateProductVariantInput + +Ƭ **CreateProductVariantInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductVariantOption`](admin_discounts.internal.mdx#productvariantoption)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`ProductVariantPrice`](admin_discounts.internal.mdx#productvariantprice)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateRegionInput + +Ƭ **CreateRegionInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateReservationItemInput + +Ƭ **CreateReservationItemInput**: `Object` + +#### Type declaration + + \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateReturnInput + +Ƭ **CreateReturnInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "`object`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method.option_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method.price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateReturnReason + +Ƭ **CreateReturnReason**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateReturnType + +Ƭ **CreateReturnType**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`Return`](../../internal/classes/admin_collections.internal.Return.mdx), ``"beforeInsert"``\> + +___ + +### CreateSalesChannelInput + +Ƭ **CreateSalesChannelInput**: `Object` + +#### Type declaration + + + +___ + +### CreateShipmentConfig + +Ƭ **CreateShipmentConfig**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateShippingMethod + +Ƭ **CreateShippingMethod**: `Object` + +#### Type declaration + + + +___ + +### CreateShippingMethodDto + +Ƭ **CreateShippingMethodDto**: [`CreateShippingMethod`](admin_discounts.internal.mdx#createshippingmethod) & { `cart?`: [`Cart`](../../internal/classes/admin_collections.internal.Cart.mdx) ; `order?`: [`Order`](../../internal/classes/admin_collections.internal.Order.mdx) } + +___ + +### CreateShippingOptionInput + +Ƭ **CreateShippingOptionInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../../internal/enums/admin_collections.internal.ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](../../internal/classes/admin_collections.internal.ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateShippingProfile + +Ƭ **CreateShippingProfile**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../../internal/enums/admin_collections.internal.ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateStockLocationInput + +Ƭ **CreateStockLocationInput**: `Object` + +#### Schema + +Represents the Input to create a Stock Location + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### CreateTaxRateInput + +Ƭ **CreateTaxRateInput**: `Object` + +#### Type declaration + + + +___ + +### CustomerGroupConstructorProps + +Ƭ **CustomerGroupConstructorProps**: `Object` + +#### Type declaration + + + +___ + +### DefaultWithoutRelations + +Ƭ **DefaultWithoutRelations**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`ExtendedFindConfig`](../../internal/modules/admin_discounts.internal.internal.mdx#extendedfindconfig)<[`CustomerGroup`](../../internal/classes/admin_collections.internal.CustomerGroup.mdx)\>, ``"relations"``\> + +___ + +### DefaultWithoutRelations + +Ƭ **DefaultWithoutRelations**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`ExtendedFindConfig`](admin_discounts.internal.mdx#extendedfindconfig)<[`Product`](../../internal/classes/admin_collections.internal.Product.mdx)\>, ``"relations"``\> + +___ + +### DeleteFileType + +Ƭ **DeleteFileType**: `Object` + +#### Index signature + +▪ [x: `string`]: `unknown` + +#### Type declaration + + + +___ + +### DeleteResponse + +Ƭ **DeleteResponse**: `Object` + +#### Type declaration + + + +___ + +### Discount + +Ƭ **Discount**: `Object` + +#### Type declaration + + + +___ + +### DiscountAllocation + +Ƭ **DiscountAllocation**: `Object` + +The amount of a discount allocated to a line item + +#### Type declaration + + + +___ + +### DiscountConditionInput + +Ƭ **DiscountConditionInput**: `Object` + +#### Type declaration + + + +___ + +### DiscountConditionResourceType + +Ƭ **DiscountConditionResourceType**: `EntityTarget`<[`DiscountConditionProduct`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionProduct.mdx) \| [`DiscountConditionProductType`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionProductType.mdx) \| [`DiscountConditionProductCollection`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionProductCollection.mdx) \| [`DiscountConditionProductTag`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionProductTag.mdx) \| [`DiscountConditionCustomerGroup`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx)\> + +___ + +### DraftOrderCreateProps + +Ƭ **DraftOrderCreateProps**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](admin_discounts.internal.mdx#discount)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`Item`](admin_discounts.internal.mdx#item)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Partial`](admin_discounts.internal.mdx#partial)<[`AddressPayload`](../../internal/classes/addresses.internal.AddressPayload.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](admin_discounts.internal.mdx#shippingmethod)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### EmitData + +Ƭ **EmitData**<`T`\>: `Object` + +#### Type parameters + + + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### ExtendedFindConfig + +Ƭ **ExtendedFindConfig**<`TEntity`\>: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<`FindOneOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> \| [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#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 + + + +___ + +### ExtendedStoreDTO + +Ƭ **ExtendedStoreDTO**: [`Store`](../../internal/classes/admin_discounts.internal.internal.Store.mdx) & { `feature_flags`: [`FeatureFlagsResponse`](admin_discounts.internal.mdx#featureflagsresponse) ; `fulfillment_providers`: [`FulfillmentProvider`](../../internal/classes/admin_collections.internal.FulfillmentProvider.mdx)[] ; `modules`: [`ModulesResponse`](admin_discounts.internal.mdx#modulesresponse) ; `payment_providers`: [`PaymentProvider`](../../internal/classes/admin_collections.internal.PaymentProvider.mdx)[] } + +#### 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" + +___ + +### ExternalModuleDeclaration + +Ƭ **ExternalModuleDeclaration**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "scope", + "type": "[`EXTERNAL`](admin_discounts.internal.mdx#external)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "server", + "type": "`object`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "server.keepAlive", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "server.type", + "type": "``\"http\"``", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "server.url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### FeatureFlagsResponse + +Ƭ **FeatureFlagsResponse**: { `key`: `string` ; `value`: `boolean` \| 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 + +___ + +### FeatureFlagsResponse + +Ƭ **FeatureFlagsResponse**: { `key`: `string` ; `value`: `boolean` \| 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 + +___ + +### FileServiceGetUploadStreamResult + +Ƭ **FileServiceGetUploadStreamResult**: `Object` + +#### Index signature + +▪ [x: `string`]: `unknown` + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "writeStream", + "type": "[`PassThrough`](../../internal/classes/admin_discounts.internal.PassThrough.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### FileServiceUploadResult + +Ƭ **FileServiceUploadResult**: `Object` + +#### Type declaration + + + +___ + +### FilterableInventoryItemProps + +Ƭ **FilterableInventoryItemProps**: `Object` + +#### Type declaration + + + +___ + +### FilterableInventoryLevelProps + +Ƭ **FilterableInventoryLevelProps**: `Object` + +#### Type declaration + + + +___ + +### FilterableReservationItemProps + +Ƭ **FilterableReservationItemProps**: `Object` + +#### Type declaration + + + +___ + +### FilterableStockLocationProps + +Ƭ **FilterableStockLocationProps**: `Object` + +#### Type declaration + + + +___ + +### FilterableTaxRateProps + +Ƭ **FilterableTaxRateProps**: `Object` + +#### Type declaration + + + +___ + +### FilterableUserProps + +Ƭ **FilterableUserProps**: [`PartialPick`](../../internal/modules/admin_discounts.internal.internal.mdx#partialpick)<[`User`](../../internal/classes/admin_auth.internal.User.mdx), ``"email"`` \| ``"first_name"`` \| ``"last_name"`` \| ``"created_at"`` \| ``"updated_at"`` \| ``"deleted_at"``\> + +___ + +### FindProductConfig + +Ƭ **FindProductConfig**: [`FindConfig`](../../internal/interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Product`](../../internal/classes/admin_collections.internal.Product.mdx)\> & [`PriceListLoadConfig`](../../internal/modules/admin_discounts.internal.internal.mdx#pricelistloadconfig) + +___ + +### FindWithRelationsOptions + +Ƭ **FindWithRelationsOptions**: `FindManyOptions`<[`ProductVariant`](../../internal/classes/admin_collections.internal.ProductVariant.mdx)\> & { `order?`: `FindOptionsOrder`<[`ProductVariant`](../../internal/classes/admin_collections.internal.ProductVariant.mdx)\> ; `withDeleted?`: `boolean` } + +___ + +### FindWithoutRelationsOptions + +Ƭ **FindWithoutRelationsOptions**: [`DefaultWithoutRelations`](admin_discounts.internal.mdx#defaultwithoutrelations) & { `where`: [`DefaultWithoutRelations`](admin_discounts.internal.mdx#defaultwithoutrelations)[``"where"``] & { `discount_condition_id?`: `string` \| `FindOperator`<`string`\> } } + +___ + +### FindWithoutRelationsOptions + +Ƭ **FindWithoutRelationsOptions**: [`DefaultWithoutRelations`](admin_discounts.internal.mdx#defaultwithoutrelations-1) & { `where`: [`DefaultWithoutRelations`](admin_discounts.internal.mdx#defaultwithoutrelations-1)[``"where"``] & { `categories?`: `FindOptionsWhere`<[`ProductCategory`](../../internal/classes/admin_collections.internal.ProductCategory.mdx)\> ; `category_id?`: [`CategoryQueryParams`](admin_discounts.internal.mdx#categoryqueryparams) ; `discount_condition_id?`: `string` ; `include_category_children?`: `boolean` ; `price_list_id?`: `FindOperator`<[`PriceList`](../../internal/classes/admin_collections.internal.PriceList.mdx)\> ; `sales_channel_id?`: `FindOperator`<[`SalesChannel`](../../internal/classes/admin_collections.internal.SalesChannel.mdx)\> ; `tags?`: `FindOperator`<[`ProductTag`](../../internal/classes/admin_collections.internal.ProductTag.mdx)\> } } + +___ + +### FulFillmentItemType + +Ƭ **FulFillmentItemType**: `Object` + +#### Type declaration + + + +___ + +### FulfillmentItemPartition + +Ƭ **FulfillmentItemPartition**: `Object` + +#### Type declaration + + + +___ + +### FulfillmentOptions + +Ƭ **FulfillmentOptions**: `Object` + +#### Type declaration + +[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### FulfillmentProviderContainer + +Ƭ **FulfillmentProviderContainer**: [`MedusaContainer`](../../internal/modules/admin_discounts.internal.internal.mdx#medusacontainer) & { `fulfillmentProviderRepository`: typeof [`FulfillmentProviderRepository`](admin_discounts.internal.mdx#fulfillmentproviderrepository) ; `manager`: `EntityManager` } & { [key in \`${FulfillmentProviderKey}\`]: typeof BaseFulfillmentService } + +___ + +### FulfillmentProviderData + +Ƭ **FulfillmentProviderData**: Record<`string`, `unknown`\> + +___ + +### FulfillmentProviderKey + +Ƭ **FulfillmentProviderKey**: \`fp\_${string}\` + +___ + +### GenerateInputData + +Ƭ **GenerateInputData**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "variantId", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### GenerateLineItemContext + +Ƭ **GenerateLineItemContext**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### GeneratedAdjustment + +Ƭ **GeneratedAdjustment**: `Object` + +#### Type declaration + + + +___ + +### GetLineItemTotalOptions + +Ƭ **GetLineItemTotalOptions**: `Object` + +#### Type declaration + + + +___ + +### GetRegionPriceContext + +Ƭ **GetRegionPriceContext**: `Object` + +#### Type declaration + + + +___ + +### GetShippingMethodTotalsOptions + +Ƭ **GetShippingMethodTotalsOptions**: `Object` + +#### Type declaration + + + +___ + +### GetTotalsOptions + +Ƭ **GetTotalsOptions**: `Object` + +#### Type declaration + + + +___ + +### GetUploadedFileType + +Ƭ **GetUploadedFileType**: `Object` + +#### Index signature + +▪ [x: `string`]: `unknown` + +#### Type declaration + + + +___ + +### GiftCardAllocation + +Ƭ **GiftCardAllocation**: `Object` + +The amount of a gift card allocated to a line item + +#### Type declaration + + + +___ + +### GiftCardTransaction + +Ƭ **GiftCardTransaction**: `Object` + +#### Type declaration + + + +___ + +### HttpCompressionOptions + +Ƭ **HttpCompressionOptions**: `Object` + +#### Type declaration + + + +___ + +### IdempotencyCallbackResult + +Ƭ **IdempotencyCallbackResult**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "response_code", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: [`MedusaContainer`](../../internal/modules/admin_discounts.internal.internal.mdx#medusacontainer) & { `eventBusService`: [`EventBusService`](../../internal/classes/admin_discounts.internal.internal.EventBusService.mdx) ; `manager`: `EntityManager` ; `oauthRepository`: typeof [`OauthRepository`](admin_discounts.internal.mdx#oauthrepository) } + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: { `customerService`: [`CustomerService`](../../internal/classes/admin_discounts.internal.internal.CustomerService.mdx) ; `featureFlagRouter`: [`FlagRouter`](../../internal/classes/admin_discounts.internal.FlagRouter.mdx) ; `logger`: [`Logger`](../../internal/modules/admin_discounts.internal.internal.mdx#logger) ; `manager`: `EntityManager` ; `paymentProviderRepository`: typeof [`PaymentProviderRepository`](admin_discounts.internal.mdx#paymentproviderrepository) ; `paymentRepository`: typeof [`PaymentRepository`](admin_discounts.internal.mdx#paymentrepository) ; `paymentService`: [`PaymentService`](../../internal/classes/admin_discounts.internal.PaymentService.mdx) ; `paymentSessionRepository`: typeof [`PaymentSessionRepository`](admin_discounts.internal.mdx#paymentsessionrepository) ; `refundRepository`: typeof [`RefundRepository`](admin_discounts.internal.mdx#refundrepository) } & { [key in \`${PaymentProviderKey}\`]: AbstractPaymentService \| typeof BasePaymentService } + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Index signature + +▪ [key: `string`]: `unknown` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + + + +___ + +### InjectedProps + +Ƭ **InjectedProps**: `Object` + +#### Type declaration + + + +___ + +### InternalModuleDeclaration + +Ƭ **InternalModuleDeclaration**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "resolve", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "resources", + "type": "[`MODULE_RESOURCE_TYPE`](../../internal/enums/admin_discounts.internal.MODULE_RESOURCE_TYPE.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "scope", + "type": "[`INTERNAL`](admin_discounts.internal.mdx#internal)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### InventoryItemDTO + +Ƭ **InventoryItemDTO**: `Object` + +#### Schema + +Title of the inventory item + +#### Type declaration + + \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requires_shipping", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### InventoryLevelDTO + +Ƭ **InventoryLevelDTO**: `Object` + +#### Schema + +The date with timezone at which the resource was created. + +#### Type declaration + + \\| ``null``", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reserved_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "stocked_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### Item + +Ƭ **Item**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### IteratorResult + +Ƭ **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../../internal/interfaces/admin_discounts.internal.IteratorYieldResult.mdx)<`T`\> \| [`IteratorReturnResult`](../../internal/interfaces/admin_discounts.internal.IteratorReturnResult.mdx)<`TReturn`\> + +#### Type parameters + + + +___ + +### JoinerRelationship + +Ƭ **JoinerRelationship**: `Object` + +#### Type declaration + +", + "description": "Extra arguments to pass to the remoteFetchData callback", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "foreignKey", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inverse", + "type": "`boolean`", + "description": "In an inverted relationship the foreign key is on the other service and the primary key is on the current service", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isInternalService", + "type": "`boolean`", + "description": "If true, the relationship is an internal service from the medusa core TODO: Remove when there are no more \"internal\" services", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isList", + "type": "`boolean`", + "description": "Force the relationship to return a list", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "primaryKey", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "serviceName", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### LineAllocationsMap + +Ƭ **LineAllocationsMap**: `object` + +A map of line item ids and its corresponding gift card and discount +allocations + +#### Index signature + +▪ [K: `string`]: { `discount?`: [`DiscountAllocation`](admin_discounts.internal.mdx#discountallocation) ; `gift_card?`: [`GiftCardAllocation`](admin_discounts.internal.mdx#giftcardallocation) } + +___ + +### LineDiscount + +Ƭ **LineDiscount**: `Object` + +Associates a line item and discount allocation. + +#### Type declaration + + + +___ + +### LineDiscountAmount + +Ƭ **LineDiscountAmount**: `Object` + +Associates a line item and discount allocation. + +#### Type declaration + + + +___ + +### LineItemAdjustmentServiceProps + +Ƭ **LineItemAdjustmentServiceProps**: `Object` + +#### Type declaration + + + +___ + +### LineItemTotals + +Ƭ **LineItemTotals**: `Object` + +#### Type declaration + + + +___ + +### LineItemTotals + +Ƭ **LineItemTotals**: `Object` + +#### Type declaration + + + +___ + +### LineItemTotalsOptions + +Ƭ **LineItemTotalsOptions**: `Object` + +#### Type declaration + + + +___ + +### LineItemUpdate + +Ƭ **LineItemUpdate**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "should_calculate_prices", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### LineItemValidateData + +Ƭ **LineItemValidateData**: `Object` + +#### Type declaration + + + +___ + +### ListAndCountSelector + +Ƭ **ListAndCountSelector**: [`Selector`](../../internal/modules/admin_discounts.internal.internal.mdx#selector)<[`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)\> & { `discount_condition_id?`: `string` ; `q?`: `string` } + +___ + +### MedusaContainer + +Ƭ **MedusaContainer**: `AwilixContainer` & { `createScope`: () => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer) ; `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer) } + +___ + +### MedusaContainer + +Ƭ **MedusaContainer**: `AwilixContainer` & { `createScope`: () => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer-1) ; `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer-1) } + +___ + +### ModuleDefinition + +Ƭ **ModuleDefinition**: `Object` + +#### Type declaration + + + +___ + +### ModuleJoinerConfig + +Ƭ **ModuleJoinerConfig**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`JoinerServiceConfig`](../../internal/interfaces/admin_discounts.internal.JoinerServiceConfig.mdx), ``"serviceName"`` \| ``"primaryKeys"`` \| ``"relationships"`` \| ``"extends"``\> & { `databaseConfig?`: { `extraFields?`: Record<`string`, { `defaultValue?`: `string` ; `nullable?`: `boolean` ; `options?`: 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<`string`, `string` \| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\> ; `relationship`: [`ModuleJoinerRelationship`](admin_discounts.internal.mdx#modulejoinerrelationship) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](admin_discounts.internal.mdx#modulejoinerrelationship)[] ; `schema?`: `string` ; `serviceName?`: `string` } + +___ + +### ModuleJoinerRelationship + +Ƭ **ModuleJoinerRelationship**: [`JoinerRelationship`](admin_discounts.internal.mdx#joinerrelationship) & { `deleteCascade?`: `boolean` ; `isInternalService?`: `boolean` } + +___ + +### ModulesResponse + +Ƭ **ModulesResponse**: [`ModulesResponse`](admin_discounts.internal.mdx#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 + +___ + +### ModulesResponse + +Ƭ **ModulesResponse**: { `module`: `string` ; `resolution`: `string` \| ``false`` }[] + +___ + +### OrdersReturnItem + +Ƭ **OrdersReturnItem**: `Object` + +#### Type declaration + + + +___ + +### PaginatedResponse + +Ƭ **PaginatedResponse**: `Object` + +#### Type declaration + + + +___ + +### Partial + +Ƭ **Partial**<`T`\>: { [P in keyof T]?: T[P] } + +Make all properties in T optional + +#### Type parameters + + + +___ + +### PaymentCollectionsSessionsBatchInput + +Ƭ **PaymentCollectionsSessionsBatchInput**: `Object` + +#### Type declaration + + + +___ + +### PaymentCollectionsSessionsInput + +Ƭ **PaymentCollectionsSessionsInput**: `Object` + +#### Type declaration + + + +___ + +### PaymentDataInput + +Ƭ **PaymentDataInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### PaymentProviderKey + +Ƭ **PaymentProviderKey**: \`pp\_${string}\` \| ``"systemPaymentProviderService"`` + +___ + +### PaymentSessionInput + +Ƭ **PaymentSessionInput**: `Object` + +#### Type declaration + + ; `email`: `string` ; `id`: `string` ; `shipping_address`: [`Address`](../../internal/classes/admin_collections.internal.Address.mdx) \\| ``null`` ; `shipping_methods`: [`ShippingMethod`](../../internal/classes/admin_collections.internal.ShippingMethod.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](../../internal/classes/admin_collections.internal.Customer.mdx) \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentSessionData", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### Price + +Ƭ **Price**: [`Partial`](admin_discounts.internal.mdx#partial)<[`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`MoneyAmount`](../../internal/classes/admin_collections.internal.MoneyAmount.mdx), ``"created_at"`` \| ``"updated_at"`` \| ``"deleted_at"``\>\> & { `amount`: `number` } + +___ + +### PriceListConstructorProps + +Ƭ **PriceListConstructorProps**: `Object` + +#### Type declaration + + + +___ + +### PricedProduct + +Ƭ **PricedProduct**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`Partial`](admin_discounts.internal.mdx#partial)<[`Product`](../../internal/classes/admin_collections.internal.Product.mdx)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](admin_discounts.internal.mdx#pricedvariant)[] } + +#### Schema + +PricedProduct +title: "Priced Product" +type: object +allOf: + - $ref: "#/components/schemas/Product" + - type: object + properties: + variants: + type: array + items: + $ref: "#/components/schemas/PricedVariant" + +___ + +### PricedShippingOption + +Ƭ **PricedShippingOption**: [`Partial`](admin_discounts.internal.mdx#partial)<[`ShippingOption`](../../internal/classes/admin_collections.internal.ShippingOption.mdx)\> & [`ShippingOptionPricing`](admin_discounts.internal.mdx#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. + +___ + +### PricedVariant + +Ƭ **PricedVariant**: [`Partial`](admin_discounts.internal.mdx#partial)<[`ProductVariant`](../../internal/classes/admin_collections.internal.ProductVariant.mdx)\> & [`ProductVariantPricing`](admin_discounts.internal.mdx#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 + +___ + +### PricingContext + +Ƭ **PricingContext**: `Object` + +#### Type declaration + + + +___ + +### ProductCategoryInput + +Ƭ **ProductCategoryInput**: `Object` + +#### Type declaration + + + +___ + +### ProductOptionInput + +Ƭ **ProductOptionInput**: `Object` + +#### Type declaration + + + +___ + +### ProductSelector + +Ƭ **ProductSelector**: [`FilterableProductProps`](../../internal/classes/admin_discounts.internal.FilterableProductProps.mdx) \| [`Selector`](../../internal/modules/admin_discounts.internal.internal.mdx#selector)<[`Product`](../../internal/classes/admin_collections.internal.Product.mdx)\> & { `category_id?`: `string`[] \| `FindOperator`<[`ProductCategory`](../../internal/classes/admin_collections.internal.ProductCategory.mdx)\> ; `discount_condition_id?`: `string` ; `price_list_id?`: `string`[] \| `FindOperator`<[`PriceList`](../../internal/classes/admin_collections.internal.PriceList.mdx)\> ; `q?`: `string` ; `sales_channel_id?`: `string`[] \| `FindOperator`<[`SalesChannel`](../../internal/classes/admin_collections.internal.SalesChannel.mdx)\> } + +___ + +### ProductVariantOption + +Ƭ **ProductVariantOption**: `Object` + +#### Type declaration + + + +___ + +### ProductVariantPrice + +Ƭ **ProductVariantPrice**: `Object` + +#### Type declaration + + + +___ + +### 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`](../../internal/classes/admin_collections.internal.MoneyAmount.mdx)[] } & [`TaxedPricing`](admin_discounts.internal.mdx#taxedpricing) + +___ + +### ProjectConfigOptions + +Ƭ **ProjectConfigOptions**: `Object` + +#### Type declaration + + & { `ssl`: { `rejectUnauthorized`: ``false`` } }", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "database_logging", + "type": "`LoggerOptions`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "database_schema", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "database_type", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "database_url", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "http_compression", + "type": "[`HttpCompressionOptions`](admin_discounts.internal.mdx#httpcompressionoptions)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "jwt_secret", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "redis_options", + "type": "`RedisOptions`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "redis_prefix", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "redis_url", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "session_options", + "type": "[`SessionOptions`](admin_discounts.internal.mdx#sessionoptions)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "store_cors", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### PropertyDecorator + +Ƭ **PropertyDecorator**: (`target`: [`Object`](admin_discounts.internal.mdx#object), `propertyKey`: `string` \| `symbol`) => `void` + +#### Type declaration + +▸ (`target`, `propertyKey`): `void` + +##### Parameters + + + +##### Returns + +`void` + + + +___ + +### PropertyKey + +Ƭ **PropertyKey**: `string` \| `number` \| `symbol` + +___ + +### ProviderLineItemTaxLine + +Ƭ **ProviderLineItemTaxLine**: `Object` + +The tax line properties for a given line item. + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### ProviderShippingMethodTaxLine + +Ƭ **ProviderShippingMethodTaxLine**: `Object` + +The tax line properties for a given shipping method. + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### ProviderTaxLine + +Ƭ **ProviderTaxLine**: [`ProviderLineItemTaxLine`](admin_discounts.internal.mdx#providerlineitemtaxline) \| [`ProviderShippingMethodTaxLine`](admin_discounts.internal.mdx#providershippingmethodtaxline) + +A union type of the possible provider tax lines. + +___ + +### ReadableStreamController + +Ƭ **ReadableStreamController**<`T`\>: [`ReadableStreamDefaultController`](admin_discounts.internal.mdx#readablestreamdefaultcontroller)<`T`\> + +#### Type parameters + + + +___ + +### ReadableStreamDefaultReadResult + +Ƭ **ReadableStreamDefaultReadResult**<`T`\>: [`ReadableStreamDefaultReadValueResult`](../../internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadValueResult.mdx)<`T`\> \| [`ReadableStreamDefaultReadDoneResult`](../../internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadDoneResult.mdx) + +#### Type parameters + + + +___ + +### RegionDetails + +Ƭ **RegionDetails**: `Object` + +#### Type declaration + + + +___ + +### ReorderConditions + +Ƭ **ReorderConditions**: `Object` + +#### Type declaration + + + +___ + +### RequestContext + +Ƭ **RequestContext**: `Object` + +#### Type declaration + + + +___ + +### ReservationItemDTO + +Ƭ **ReservationItemDTO**: `Object` + +#### Schema + +Represents a reservation of an inventory item at a stock location + +#### Type declaration + + \\| ``null``", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### ReserveQuantityContext + +Ƭ **ReserveQuantityContext**: `Object` + +#### Type declaration + + + +___ + +### ReturnedData + +Ƭ **ReturnedData**: `Object` + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "to", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### SessionOptions + +Ƭ **SessionOptions**: `Object` + +#### Type declaration + + + +___ + +### SharedContext + +Ƭ **SharedContext**: `Object` + +#### Type declaration + + + +___ + +### ShippingMethod + +Ƭ **ShippingMethod**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### ShippingMethodData + +Ƭ **ShippingMethodData**: Record<`string`, `unknown`\> + +___ + +### ShippingMethodTotals + +Ƭ **ShippingMethodTotals**: `Object` + +#### Type declaration + + + +___ + +### ShippingMethodTotals + +Ƭ **ShippingMethodTotals**: `Object` + +#### Type declaration + + + +___ + +### ShippingMethodUpdate + +Ƭ **ShippingMethodUpdate**: `Object` + +#### Type declaration + + + +___ + +### ShippingOptionData + +Ƭ **ShippingOptionData**: Record<`string`, `unknown`\> + +___ + +### ShippingOptionPricing + +Ƭ **ShippingOptionPricing**: `Object` + +#### Type declaration + + + +___ + +### StagedJobServiceProps + +Ƭ **StagedJobServiceProps**: `Object` + +#### Type declaration + + + +___ + +### StockLocationAddressDTO + +Ƭ **StockLocationAddressDTO**: `Object` + +#### Schema + +Represents a Stock Location Address + +#### Type declaration + + \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### StockLocationAddressInput + +Ƭ **StockLocationAddressInput**: `Object` + +#### Schema + +Represents a Stock Location Address Input + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### StockLocationDTO + +Ƭ **StockLocationDTO**: `Object` + +#### Schema + +Represents a Stock Location + +#### Type declaration + + \\| ``null``", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### StockLocationExpandedDTO + +Ƭ **StockLocationExpandedDTO**: [`StockLocationDTO`](admin_discounts.internal.mdx#stocklocationdto) & { `sales_channels?`: `any`[] } + +#### Schema + +StockLocationExpandedDTO +allOf: + - $ref: "#/components/schemas/StockLocationDTO" + - type: object + properties: + sales_channels: + $ref: "#/components/schemas/SalesChannel" + +___ + +### Subscriber + +Ƭ **Subscriber**<`T`\>: (`data`: `T`, `eventName`: `string`) => `Promise`<`void`\> + +#### Type parameters + + + +#### Type declaration + +▸ (`data`, `eventName`): `Promise`<`void`\> + +##### Parameters + + + +##### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### SubscriberContext + +Ƭ **SubscriberContext**: `Object` + +#### Type declaration + + + +___ + +### SubscriberDescriptor + +Ƭ **SubscriberDescriptor**: `Object` + +#### Type declaration + + + +___ + +### SubtotalOptions + +Ƭ **SubtotalOptions**: `Object` + +Options to use for subtotal calculations + +#### Type declaration + + + +___ + +### TaxLinesMaps + +Ƭ **TaxLinesMaps**: `Object` + +#### Type declaration + + + +___ + +### TaxRateListByConfig + +Ƭ **TaxRateListByConfig**: `Object` + +#### Type declaration + + + +___ + +### 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 + + + +___ + +### TaxedPricing + +Ƭ **TaxedPricing**: `Object` + +#### Type declaration + + + +___ + +### TotalsConfig + +Ƭ **TotalsConfig**: `Object` + +#### Type declaration + + + +___ + +### TotalsContext + +Ƭ **TotalsContext**: `Object` + +#### Type declaration + + + +___ + +### TotalsServiceProps + +Ƭ **TotalsServiceProps**: `Object` + +#### Type declaration + + + +___ + +### TransformCallback + +Ƭ **TransformCallback**: (`error?`: [`Error`](admin_discounts.internal.mdx#error) \| ``null``, `data?`: `any`) => `void` + +#### Type declaration + +▸ (`error?`, `data?`): `void` + +##### Parameters + + + +##### Returns + +`void` + + + +___ + +### Transformer + +Ƭ **Transformer**: (`item?`: [`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx), `quantity?`: `number`, `additional?`: [`OrdersReturnItem`](../../internal/classes/admin_discounts.internal.OrdersReturnItem.mdx)) => `Promise`<`DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\>\> \| `DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\> + +#### Type declaration + +▸ (`item?`, `quantity?`, `additional?`): `Promise`<`DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\>\> \| `DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\> + +##### Parameters + + + +##### Returns + +`Promise`<`DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\>\> \| `DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\> + +\\> \\| DeepPartial", + "type": "`Promise`<`DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\\>\\> \\| `DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### TypedArray + +Ƭ **TypedArray**: `Uint8Array` \| `Uint8ClampedArray` \| `Uint16Array` \| `Uint32Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `BigUint64Array` \| `BigInt64Array` \| `Float32Array` \| `Float64Array` + +___ + +### UpdateAnalyticsConfig + +Ƭ **UpdateAnalyticsConfig**: `Object` + +#### Type declaration + + + +___ + +### UpdateClaimInput + +Ƭ **UpdateClaimInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`UpdateClaimShippingMethodInput`](admin_discounts.internal.mdx#updateclaimshippingmethodinput)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateClaimItemImageInput + +Ƭ **UpdateClaimItemImageInput**: `Object` + +#### Type declaration + + + +___ + +### UpdateClaimItemInput + +Ƭ **UpdateClaimItemInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`UpdateClaimItemTagInput`](admin_discounts.internal.mdx#updateclaimitemtaginput)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateClaimItemTagInput + +Ƭ **UpdateClaimItemTagInput**: `Object` + +#### Type declaration + + + +___ + +### UpdateClaimShippingMethodInput + +Ƭ **UpdateClaimShippingMethodInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateCurrencyInput + +Ƭ **UpdateCurrencyInput**: `Object` + +#### Type declaration + + + +___ + +### UpdateCustomerInput + +Ƭ **UpdateCustomerInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "password", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateDiscountInput + +Ƭ **UpdateDiscountInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "`string`[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`UpdateDiscountRuleInput`](admin_discounts.internal.mdx#updatediscountruleinput)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "`number` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateDiscountRuleInput + +Ƭ **UpdateDiscountRuleInput**: `Object` + +#### Type declaration + + + +___ + +### UpdateGiftCardInput + +Ƭ **UpdateGiftCardInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateInventoryLevelInput + +Ƭ **UpdateInventoryLevelInput**: `Object` + +#### Type declaration + + + +___ + +### UpdateOauthInput + +Ƭ **UpdateOauthInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateOrderInput + +Ƭ **UpdateOrderInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](../../internal/classes/admin_collections.internal.Payment.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_method", + "type": "`object`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_method.data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_method.provider_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../../internal/enums/admin_discounts.internal.PaymentStatus.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`AddressPayload`](../../internal/classes/addresses.internal.AddressPayload.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "{ `data?`: Record<`string`, `unknown`\\> ; `items?`: Record<`string`, `unknown`\\>[] ; `price?`: `number` ; `profile_id?`: `string` ; `provider_id?`: `string` }[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../../internal/enums/admin_discounts.internal.OrderStatus.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateProductCategoryInput + +Ƭ **UpdateProductCategoryInput**: [`ProductCategoryInput`](admin_discounts.internal.mdx#productcategoryinput) & { `name?`: `string` } + +___ + +### UpdateProductCollection + +Ƭ **UpdateProductCollection**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateProductInput + +Ƭ **UpdateProductInput**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`Partial`](admin_discounts.internal.mdx#partial)<[`CreateProductInput`](admin_discounts.internal.mdx#createproductinput)\>, ``"variants"``\> & { `variants?`: [`UpdateProductProductVariantDTO`](admin_discounts.internal.mdx#updateproductproductvariantdto)[] } + +___ + +### UpdateProductProductVariantDTO + +Ƭ **UpdateProductProductVariantDTO**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "{ `option_id`: `string` ; `value`: `string` }[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`CreateProductProductVariantPriceInput`](admin_discounts.internal.mdx#createproductproductvariantpriceinput)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateProductVariantData + +Ƭ **UpdateProductVariantData**: `Object` + +#### Type declaration + + + +___ + +### UpdateProductVariantInput + +Ƭ **UpdateProductVariantInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductVariantOption`](admin_discounts.internal.mdx#productvariantoption)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`ProductVariantPrice`](admin_discounts.internal.mdx#productvariantprice)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateRegionInput + +Ƭ **UpdateRegionInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "`string`[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "`string` \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateReservationItemInput + +Ƭ **UpdateReservationItemInput**: `Object` + +#### Type declaration + + \\| ``null``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateReturnInput + +Ƭ **UpdateReturnInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "`object`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method.option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method.price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateReturnReason + +Ƭ **UpdateReturnReason**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateShippingOptionInput + +Ƭ **UpdateShippingOptionInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../../internal/enums/admin_collections.internal.ShippingOptionPriceType.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](../../internal/classes/admin_collections.internal.ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateShippingProfile + +Ƭ **UpdateShippingProfile**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "`string`[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "`string`[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../../internal/enums/admin_collections.internal.ShippingProfileType.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateStockLocationInput + +Ƭ **UpdateStockLocationInput**: `Object` + +#### Schema + +Represents the Input to update a Stock Location + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateStoreInput + +Ƭ **UpdateStoreInput**: `Object` + +#### Type declaration + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_link_template", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_link_template", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### UpdateTaxRateInput + +Ƭ **UpdateTaxRateInput**: `Object` + +#### Type declaration + + + +___ + +### UpdateVariantPricesData + +Ƭ **UpdateVariantPricesData**: `Object` + +#### Type declaration + + + +___ + +### UpdateVariantRegionPriceData + +Ƭ **UpdateVariantRegionPriceData**: `Object` + +#### Type declaration + + + +___ + +### UploadStreamDescriptorType + +Ƭ **UploadStreamDescriptorType**: `Object` + +#### Index signature + +▪ [x: `string`]: `unknown` + +#### Type declaration + + + +___ + +### UpsertTagsInput + +Ƭ **UpsertTagsInput**: [`Partial`](admin_discounts.internal.mdx#partial)<[`ProductTag`](../../internal/classes/admin_collections.internal.ProductTag.mdx)\> & { `value`: `string` }[] + +___ + +### UpsertTypeInput + +Ƭ **UpsertTypeInput**: [`Partial`](admin_discounts.internal.mdx#partial)<[`ProductType`](../../internal/classes/admin_collections.internal.ProductType.mdx)\> & { `value`: `string` } + +___ + +### UserServiceProps + +Ƭ **UserServiceProps**: `Object` + +#### Type declaration + + + +___ + +### WithImplicitCoercion + +Ƭ **WithImplicitCoercion**<`T`\>: `T` \| { `valueOf`: Method valueOf } + +#### Type parameters + + + +___ + +### handler + +Ƭ **handler**: (`req`: `Request`, `res`: `Response`) => `Promise`<`void`\> + +#### Type declaration + +▸ (`req`, `res`): `Promise`<`void`\> + +##### Parameters + + + +##### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### middlewareHandlerType + +Ƭ **middlewareHandlerType**: (`options`: Record<`string`, `unknown`\>) => `RequestHandler` + +#### Type declaration + +▸ (`options`): `RequestHandler` + +##### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +`RequestHandler` + + + +___ + +### middlewareType + +Ƭ **middlewareType**: `Object` + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Variables + +### AddressRepository + +• `Const` **AddressRepository**: `Repository` + +___ + +### AdminGetDiscountsParams\_base + +• `Const` **AdminGetDiscountsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + +___ + +### AdminGetInventoryItemsParams\_base + +• `Const` **AdminGetInventoryItemsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + +___ + +### AdminGetPriceListsPriceListProductsParams\_base + +• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + +___ + +### AdminGetProductCategoriesParams\_base + +• `Const` **AdminGetProductCategoriesParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + +___ + +### AdminGetReservationsParams\_base + +• `Const` **AdminGetReservationsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + +___ + +### AdminGetSalesChannelsParams\_base + +• `Const` **AdminGetSalesChannelsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + +___ + +### AdminGetStockLocationsParams\_base + +• `Const` **AdminGetStockLocationsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + +___ + +### AnalyticsConfigRepository + +• `Const` **AnalyticsConfigRepository**: `Repository` + +___ + +### BatchJobRepository + +• `Const` **BatchJobRepository**: `Repository` + +___ + +### Buffer + +• **Buffer**: [`BufferConstructor`](../../internal/interfaces/admin_discounts.internal.BufferConstructor.mdx) + +___ + +### CartRepository + +• `Const` **CartRepository**: `Repository` & { `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations } + +___ + +### ClaimRepository + +• `Const` **ClaimRepository**: `Repository` + +___ + +### CountryRepository + +• `Const` **CountryRepository**: `Repository` + +___ + +### CurrencyRepository + +• `Const` **CurrencyRepository**: `Repository` + +___ + +### CustomShippingOptionRepository + +• `Const` **CustomShippingOptionRepository**: `Repository` + +___ + +### CustomerGroupRepository + +• `Const` **CustomerGroupRepository**: `Repository` & { `addCustomers`: Method addCustomers ; `findWithRelationsAndCount`: Method findWithRelationsAndCount ; `removeCustomers`: Method removeCustomers } + +___ + +### CustomerRepository + +• `Const` **CustomerRepository**: `Repository` & { `listAndCount`: Method listAndCount } + +___ + +### DiscountConditionRepository + +• `Const` **DiscountConditionRepository**: `Repository` & { `addConditionResources`: Method addConditionResources ; `canApplyForCustomer`: Method canApplyForCustomer ; `findOneWithDiscount`: Method findOneWithDiscount ; `getJoinTableResourceIdentifiers`: Method getJoinTableResourceIdentifiers ; `isValidForProduct`: Method isValidForProduct ; `queryConditionTable`: Method queryConditionTable ; `removeConditionResources`: Method removeConditionResources } + +___ + +### DraftOrderRepository + +• `Const` **DraftOrderRepository**: `Repository` + +___ + +### FulfillmentProviderRepository + +• `Const` **FulfillmentProviderRepository**: `Repository` + +___ + +### FulfillmentRepository + +• `Const` **FulfillmentRepository**: `Repository` + +___ + +### GetOrderEditsParams\_base + +• `Const` **GetOrderEditsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + +___ + +### GetPublishableApiKeySalesChannelsParams\_base + +• `Const` **GetPublishableApiKeySalesChannelsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + +___ + +### GetPublishableApiKeysParams\_base + +• `Const` **GetPublishableApiKeysParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + +___ + +### GiftCardRepository + +• `Const` **GiftCardRepository**: `Repository` & { `listGiftCardsAndCount`: Method listGiftCardsAndCount } + +___ + +### GiftCardTransactionRepository + +• `Const` **GiftCardTransactionRepository**: `Repository` + +___ + +### IdempotencyKeyRepository + +• `Const` **IdempotencyKeyRepository**: `Repository` + +___ + +### ImageRepository + +• `Const` **ImageRepository**: `Repository` & { `insertBulk`: Method insertBulk ; `upsertImages`: Method upsertImages } + +___ + +### LineItemAdjustmentRepository + +• `Const` **LineItemAdjustmentRepository**: `Repository` + +___ + +### LineItemRepository + +• `Const` **LineItemRepository**: `Repository` & { `findByReturn`: Method findByReturn } + +___ + +### LineItemTaxLineRepository + +• `Const` **LineItemTaxLineRepository**: `Repository` & { `deleteForCart`: Method deleteForCart ; `upsertLines`: Method upsertLines } + +___ + +### MoneyAmountRepository + +• `Const` **MoneyAmountRepository**: `Repository` & { `addPriceListPrices`: Method addPriceListPrices ; `createProductVariantMoneyAmounts`: Method createProductVariantMoneyAmounts ; `deletePriceListPrices`: Method deletePriceListPrices ; `deleteVariantPricesNotIn`: Method deleteVariantPricesNotIn ; `findCurrencyMoneyAmounts`: Method findCurrencyMoneyAmounts ; `findManyForVariantInPriceList`: Method findManyForVariantInPriceList ; `findManyForVariantInRegion`: Method findManyForVariantInRegion ; `findManyForVariantsInRegion`: Method findManyForVariantsInRegion ; `findRegionMoneyAmounts`: Method findRegionMoneyAmounts ; `findVariantPricesNotIn`: Method findVariantPricesNotIn ; `getPricesForVariantInRegion`: Method getPricesForVariantInRegion ; `insertBulk`: Method insertBulk ; `updatePriceListPrices`: Method updatePriceListPrices ; `upsertVariantCurrencyPrice`: Method upsertVariantCurrencyPrice } + +___ + +### NoteRepository + +• `Const` **NoteRepository**: `Repository` + +___ + +### NotificationProviderRepository + +• `Const` **NotificationProviderRepository**: `Repository` + +___ + +### NotificationRepository + +• `Const` **NotificationRepository**: `Repository` + +___ + +### OauthRepository + +• `Const` **OauthRepository**: `Repository` + +___ + +### OrderEditRepository + +• `Const` **OrderEditRepository**: `Repository` + +___ + +### OrderItemChangeRepository + +• `Const` **OrderItemChangeRepository**: `Repository` + +___ + +### OrderRepository + +• `Const` **OrderRepository**: `Repository` & { `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations } + +___ + +### PaymentCollectionRepository + +• `Const` **PaymentCollectionRepository**: `Repository` & { `getPaymentCollectionIdByPaymentId`: Method getPaymentCollectionIdByPaymentId ; `getPaymentCollectionIdBySessionId`: Method getPaymentCollectionIdBySessionId } + +___ + +### PaymentProviderRepository + +• `Const` **PaymentProviderRepository**: `Repository` + +___ + +### PaymentRepository + +• `Const` **PaymentRepository**: `Repository` + +___ + +### PaymentSessionRepository + +• `Const` **PaymentSessionRepository**: `Repository` + +___ + +### PriceListRepository + +• `Const` **PriceListRepository**: `Repository` & { `listAndCount`: Method listAndCount ; `listPriceListsVariantIdsMap`: Method listPriceListsVariantIdsMap } + +___ + +### ProductCategoryRepository + +• `Const` **ProductCategoryRepository**: `TreeRepository` & { `addProducts`: Method addProducts ; `findOneWithDescendants`: Method findOneWithDescendants ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `removeProducts`: Method removeProducts } + +___ + +### ProductCollectionRepository + +• `Const` **ProductCollectionRepository**: `Repository` & { `findAndCountByDiscountConditionId`: Method findAndCountByDiscountConditionId } + +___ + +### ProductOptionRepository + +• `Const` **ProductOptionRepository**: `Repository` + +___ + +### ProductRepository + +• `Const` **ProductRepository**: `Repository` & { `_applyCategoriesQuery`: Method \_applyCategoriesQuery ; `_findWithRelations`: Method \_findWithRelations ; `bulkAddToCollection`: Method bulkAddToCollection ; `bulkRemoveFromCollection`: Method bulkRemoveFromCollection ; `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations ; `findWithRelationsAndCount`: Method findWithRelationsAndCount ; `getCategoryIdsFromInput`: Method getCategoryIdsFromInput ; `getCategoryIdsRecursively`: Method getCategoryIdsRecursively ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `isProductInSalesChannels`: Method isProductInSalesChannels ; `queryProducts`: Method queryProducts ; `queryProductsWithIds`: Method queryProductsWithIds } + +___ + +### ProductTagRepository + +• `Const` **ProductTagRepository**: `Repository` & { `findAndCountByDiscountConditionId`: Method findAndCountByDiscountConditionId ; `insertBulk`: Method insertBulk ; `listTagsByUsage`: Method listTagsByUsage ; `upsertTags`: Method upsertTags } + +___ + +### ProductTypeRepository + +• `Const` **ProductTypeRepository**: `Repository` & { `findAndCountByDiscountConditionId`: Method findAndCountByDiscountConditionId ; `upsertType`: Method upsertType } + +___ + +### ProductVariantRepository + +• `Const` **ProductVariantRepository**: `Repository` + +___ + +### ReadableByteStreamController + +• **ReadableByteStreamController**: `Object` + +#### Call signature + +• **new ReadableByteStreamController**(): [`ReadableByteStreamController`](admin_discounts.internal.mdx#readablebytestreamcontroller) + +##### Returns + +[`ReadableByteStreamController`](admin_discounts.internal.mdx#readablebytestreamcontroller) + + [`ReadableByteStreamController`](admin_discounts.internal.mdx#readablebytestreamcontroller)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Type declaration + + + +___ + +### ReadableStream + +• **ReadableStream**: `Object` + +#### Call signature + +• **new ReadableStream**(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_discounts.internal.mdx#readablestream)<`Uint8Array`\> + +##### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +[`ReadableStream`](admin_discounts.internal.mdx#readablestream)<`Uint8Array`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Uint8Array", + "type": "`Uint8Array`", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +• **new ReadableStream**<`R`\>(`underlyingSource?`, `strategy?`): [`ReadableStream`](admin_discounts.internal.mdx#readablestream)<`R`\> + + + +##### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "strategy", + "type": "[`QueuingStrategy`](../../internal/interfaces/admin_discounts.internal.QueuingStrategy.mdx)<`R`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +[`ReadableStream`](admin_discounts.internal.mdx#readablestream)<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### ReadableStreamDefaultController + +• **ReadableStreamDefaultController**: `Object` + +#### Call signature + +• **new ReadableStreamDefaultController**(): [`ReadableStreamDefaultController`](admin_discounts.internal.mdx#readablestreamdefaultcontroller)<`any`\> + +##### Returns + +[`ReadableStreamDefaultController`](admin_discounts.internal.mdx#readablestreamdefaultcontroller)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### ReadableStreamDefaultReader + +• **ReadableStreamDefaultReader**: `Object` + +#### Call signature + +• **new ReadableStreamDefaultReader**<`R`\>(`stream`): [`ReadableStreamDefaultReader`](admin_discounts.internal.mdx#readablestreamdefaultreader)<`R`\> + + + +##### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +[`ReadableStreamDefaultReader`](admin_discounts.internal.mdx#readablestreamdefaultreader)<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### RefundRepository + +• `Const` **RefundRepository**: `Repository` + +___ + +### RegionRepository + +• `Const` **RegionRepository**: `Repository` + +___ + +### ReturnItemRepository + +• `Const` **ReturnItemRepository**: `Repository` + +___ + +### ReturnReasonRepository + +• `Const` **ReturnReasonRepository**: `Repository` + +___ + +### ReturnRepository + +• `Const` **ReturnRepository**: `Repository` + +___ + +### SalesChannelRepository + +• `Const` **SalesChannelRepository**: `Repository` & { `addProducts`: Method addProducts ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `listProductIdsBySalesChannelIds`: Method listProductIdsBySalesChannelIds ; `removeProducts`: Method removeProducts } + +___ + +### SharedArrayBuffer + +• **SharedArrayBuffer**: [`SharedArrayBufferConstructor`](../../internal/interfaces/admin_discounts.internal.SharedArrayBufferConstructor.mdx) + +___ + +### ShippingMethodRepository + +• `Const` **ShippingMethodRepository**: `Repository` + +___ + +### ShippingOptionRepository + +• `Const` **ShippingOptionRepository**: `Repository` & { `upsertShippingProfile`: Method upsertShippingProfile } + +___ + +### ShippingOptionRequirementRepository + +• `Const` **ShippingOptionRequirementRepository**: `Repository` + +___ + +### ShippingProfileRepository + +• `Const` **ShippingProfileRepository**: `Repository` & { `findByProducts`: Method findByProducts } + +___ + +### StagedJobRepository + +• `Const` **StagedJobRepository**: `Repository` & { `insertBulk`: Method insertBulk } + +___ + +### StoreGetProductCategoriesParams\_base + +• `Const` **StoreGetProductCategoriesParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + +___ + +### StoreRepository + +• `Const` **StoreRepository**: `Repository` + +___ + +### SwapRepository + +• `Const` **SwapRepository**: `Repository` + +___ + +### TaxProviderRepository + +• `Const` **TaxProviderRepository**: `Repository` + +___ + +### TrackingLinkRepository + +• `Const` **TrackingLinkRepository**: `Repository` + +___ + +### UserRepository + +• `Const` **UserRepository**: `Repository` + +___ + +### WritableStream + +• **WritableStream**: `Object` + +#### Call signature + +• **new WritableStream**<`W`\>(`underlyingSink?`, `strategy?`): [`WritableStream`](admin_discounts.internal.mdx#writablestream)<`W`\> + + + +##### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "strategy", + "type": "[`QueuingStrategy`](../../internal/interfaces/admin_discounts.internal.QueuingStrategy.mdx)<`W`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +[`WritableStream`](admin_discounts.internal.mdx#writablestream)<`W`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### WritableStreamDefaultController + +• **WritableStreamDefaultController**: `Object` + +#### Call signature + +• **new WritableStreamDefaultController**(): [`WritableStreamDefaultController`](admin_discounts.internal.mdx#writablestreamdefaultcontroller) + +##### Returns + +[`WritableStreamDefaultController`](admin_discounts.internal.mdx#writablestreamdefaultcontroller) + + [`WritableStreamDefaultController`](admin_discounts.internal.mdx#writablestreamdefaultcontroller)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Type declaration + + + +___ + +### WritableStreamDefaultWriter + +• **WritableStreamDefaultWriter**: `Object` + +#### Call signature + +• **new WritableStreamDefaultWriter**<`W`\>(`stream`): [`WritableStreamDefaultWriter`](admin_discounts.internal.mdx#writablestreamdefaultwriter)<`W`\> + + + +##### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +[`WritableStreamDefaultWriter`](admin_discounts.internal.mdx#writablestreamdefaultwriter)<`W`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Functions + +### Error + +▸ **Error**(`message?`): [`Error`](admin_discounts.internal.mdx#error) + +#### Parameters + + + +#### Returns + +[`Error`](admin_discounts.internal.mdx#error) + + [`Error`](admin_discounts.internal.mdx#error)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### Object + +▸ **Object**(): `any` + +Provides functionality common to all JavaScript objects. + +#### Returns + +`any` + + + +▸ **Object**(`value`): `any` + +Provides functionality common to all JavaScript objects. + +#### Parameters + + + +#### Returns + +`any` + + diff --git a/www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx b/www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx new file mode 100644 index 0000000000..a564255165 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx @@ -0,0 +1,544 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDraftOrdersResource + +[admin/draft-orders](../../modules/admin_draft_orders.mdx).AdminDraftOrdersResource + +## Methods + +### addLineItem + +▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDraftOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Add line item to draft order + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDraftOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Creates a draft order + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Delete draft order + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftorderslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftorderslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDraftOrdersListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `draft_orders`: [`DraftOrder`](../../internal/classes/admin_collections.internal.DraftOrder.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Lists draft orders + +___ + +### markPaid + +▸ **markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpostdraftordersdraftorderregisterpaymentres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpostdraftordersdraftorderregisterpaymentres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPostDraftOrdersDraftOrderRegisterPaymentRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Mark a draft order as paid + +___ + +### removeLineItem + +▸ **removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDraftOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Remove line item + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDraftOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a draft order + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDraftOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Update draft order + +___ + +### updateLineItem + +▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminDraftOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Update draft order line item diff --git a/www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx b/www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx new file mode 100644 index 0000000000..b39f326121 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx @@ -0,0 +1,292 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGiftCardsResource + +[admin/gift-cards](../../modules/admin_gift_cards.mdx).AdminGiftCardsResource + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminGiftCardsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Creates a gift card + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Deletes a gift card + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminGiftCardsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `gift_cards`: [`GiftCard`](../../internal/classes/admin_collections.internal.GiftCard.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Lists gift cards + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminGiftCardsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Deletes a gift card + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminGiftCardsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Updates a gift card diff --git a/www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx b/www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx new file mode 100644 index 0000000000..6ee9231b8b --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx @@ -0,0 +1,636 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminInventoryItemsResource + +[admin/inventory-item](../../modules/admin_inventory_item.mdx).AdminInventoryItemsResource + +## Methods + +### create + +▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the created Inventory Item", + "children": [ + { + "name": "AdminInventoryItemsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +creates an Inventory Item + +___ + +### createLocationLevel + +▸ **createLocationLevel**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the Inventory Item", + "children": [ + { + "name": "AdminInventoryItemsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +creates stock levle for an Inventory Item + +___ + +### delete + +▸ **delete**(`inventoryItemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "the deleted Inventory Item", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +deletes an Inventory Item + +___ + +### deleteLocationLevel + +▸ **deleteLocationLevel**(`inventoryItemId`, `locationId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the Inventory Item", + "children": [ + { + "name": "AdminInventoryItemsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +deletes a location level of an Inventory Item + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsListWithVariantsAndLocationLevelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsListWithVariantsAndLocationLevelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemslistwithvariantsandlocationlevelsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the list of Inventory Items as well as the pagination properties", + "children": [ + { + "name": "AdminInventoryItemsListWithVariantsAndLocationLevelsRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `inventory_items`: [`DecoratedInventoryItemDTO`](../../internal/modules/admin_discounts.internal.internal.mdx#decoratedinventoryitemdto)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieve a list of Inventory Items + +___ + +### listLocationLevels + +▸ **listLocationLevels**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsLocationLevelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsLocationLevelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemslocationlevelsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the list of inventory levels related to an Inventory Item as well as the pagination properties", + "children": [ + { + "name": "AdminInventoryItemsLocationLevelsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieve a list of location levels related to an Inventory Item + +___ + +### retrieve + +▸ **retrieve**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "an Inventory Item", + "children": [ + { + "name": "AdminInventoryItemsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +gets an Inventory Item + +___ + +### update + +▸ **update**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated Inventory Item", + "children": [ + { + "name": "AdminInventoryItemsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +updates an Inventory Item + +___ + +### updateLocationLevel + +▸ **updateLocationLevel**(`inventoryItemId`, `locationId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated Inventory Item", + "children": [ + { + "name": "AdminInventoryItemsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +updates an Inventory Item diff --git a/www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx b/www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx new file mode 100644 index 0000000000..b11f46c0dd --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx @@ -0,0 +1,229 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminInvitesResource + +[admin/invites](../../modules/admin_invites.mdx).AdminInvitesResource + +## Methods + +### accept + +▸ **accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) + + + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) + + + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminListInvitesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminlistinvitesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminListInvitesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminlistinvitesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminListInvitesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### resend + +▸ **resend**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) + + diff --git a/www/apps/docs/content/references/js-client/admin_invites/modules/admin_invites.internal.mdx b/www/apps/docs/content/references/js-client/admin_invites/modules/admin_invites.internal.mdx new file mode 100644 index 0000000000..3849a6538f --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_invites/modules/admin_invites.internal.mdx @@ -0,0 +1,19 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +## Type Aliases + +### AdminPostInvitesPayload + +Ƭ **AdminPostInvitesPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminPostInvitesReq`](../../internal/classes/admin_discounts.internal.internal.AdminPostInvitesReq.mdx), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](admin_invites.internal.mdx#inviteuserrolesenum) } + +___ + +### InviteUserRolesEnum + +Ƭ **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\` diff --git a/www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx b/www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx new file mode 100644 index 0000000000..d6db3c89ab --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx @@ -0,0 +1,272 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminNotesResource + +[admin/notes](../../modules/admin_notes.mdx).AdminNotesResource + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminNotesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnoteslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnoteslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminNotesListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `notes`: [`Note`](../../internal/classes/admin_discounts.internal.internal.Note.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminNotesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminNotesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx b/www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx new file mode 100644 index 0000000000..385bc0dfae --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx @@ -0,0 +1,119 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminNotificationsResource + +[admin/notifications](../../modules/admin_notifications.mdx).AdminNotificationsResource + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotificationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotificationslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotificationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotificationslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminNotificationsListRes", + "type": "[`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `notifications`: [`Notification`](../../internal/classes/admin_discounts.internal.internal.Notification.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### resend + +▸ **resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotificationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotificationsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotificationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotificationsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminNotificationsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx b/www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx new file mode 100644 index 0000000000..07514174ad --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx @@ -0,0 +1,677 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminOrderEditsResource + +[admin/order-edits](../../modules/admin_order_edits.mdx).AdminOrderEditsResource + +## Methods + +### addLineItem + +▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrderEditsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### cancel + +▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrderEditsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### confirm + +▸ **confirm**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrderEditsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrderEditsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteItemChange + +▸ **deleteItemChange**(`orderEditId`, `itemChangeId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminorderedititemchangedeleteres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminorderedititemchangedeleteres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrderEditItemChangeDeleteRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrderEditsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `order_edits`: [`OrderEdit`](../../internal/classes/admin_collections.internal.OrderEdit.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeLineItem + +▸ **removeLineItem**(`orderEditId`, `itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrderEditsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### requestConfirmation + +▸ **requestConfirmation**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrderEditsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrderEditsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrderEditsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateLineItem + +▸ **updateLineItem**(`orderEditId`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrderEditsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx b/www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx new file mode 100644 index 0000000000..577f499788 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx @@ -0,0 +1,1500 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminOrdersResource + +[admin/orders](../../modules/admin_orders.mdx).AdminOrdersResource + +## Methods + +### addShippingMethod + +▸ **addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### archive + +▸ **archive**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### cancel + +▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### cancelClaim + +▸ **cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### cancelClaimFulfillment + +▸ **cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### cancelSwap + +▸ **cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### cancelSwapFulfillment + +▸ **cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### capturePayment + +▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### complete + +▸ **complete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### createClaim + +▸ **createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### createClaimShipment + +▸ **createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### createFulfillment + +▸ **createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### createShipment + +▸ **createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### createSwap + +▸ **createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### createSwapShipment + +▸ **createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### fulfillClaim + +▸ **fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### fulfillSwap + +▸ **fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminorderslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminorderslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `orders`: [`Order`](../../internal/classes/admin_collections.internal.Order.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### processSwapPayment + +▸ **processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### refundPayment + +▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### requestReturn + +▸ **requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateClaim + +▸ **updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx b/www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx new file mode 100644 index 0000000000..c0e36e0274 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx @@ -0,0 +1,229 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPaymentCollectionsResource + +[admin/payment-collections](../../modules/admin_payment_collections.mdx).AdminPaymentCollectionsResource + +## Methods + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectiondeleteres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectiondeleteres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPaymentCollectionDeleteRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### markAsAuthorized + +▸ **markAsAuthorized**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPaymentCollectionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPaymentCollectionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPaymentCollectionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx b/www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx new file mode 100644 index 0000000000..179e538f44 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx @@ -0,0 +1,178 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPaymentsResource + +[admin/payments](../../modules/admin_payments.mdx).AdminPaymentsResource + +## Methods + +### capturePayment + +▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPaymentRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### refundPayment + +▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRefundRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminrefundres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRefundRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminrefundres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminRefundRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPaymentRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx b/www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx new file mode 100644 index 0000000000..8aef8ebbeb --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx @@ -0,0 +1,626 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPriceListResource + +[admin/price-lists](../../modules/admin_price_lists.mdx).AdminPriceListResource + +## Methods + +### addPrices + +▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPriceListRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPriceListRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### deletePrices + +▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPriceListDeleteBatchRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteProductPrices + +▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPriceListDeleteBatchRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteProductsPrices + +▸ **deleteProductsPrices**(`priceListId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPriceListDeleteBatchRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteVariantPrices + +▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPriceListDeleteBatchRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPriceListsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `price_lists`: [`PriceList`](../../internal/classes/admin_collections.internal.PriceList.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### listProducts + +▸ **listProducts**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`any`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPriceListRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPriceListRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx b/www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx new file mode 100644 index 0000000000..783a8559fe --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx @@ -0,0 +1,446 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminProductCategoriesResource + +[admin/product-categories](../../modules/admin_product_categories.mdx).AdminProductCategoriesResource + +## Methods + +### addProducts + +▸ **addProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a medusa product category", + "children": [ + { + "name": "AdminProductCategoriesCategoryRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Add products to a product category + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductCategoriesCategoryRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`productCategoryId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "an deletion result", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +gets a product category + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategorieslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the list of product category as well as the pagination properties", + "children": [ + { + "name": "AdminProductCategoriesListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_categories`: [`ProductCategory`](../../internal/classes/admin_collections.internal.ProductCategory.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieve a list of product categories + +___ + +### removeProducts + +▸ **removeProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a medusa product category", + "children": [ + { + "name": "AdminProductCategoriesCategoryRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Remove products from a product category + +___ + +### retrieve + +▸ **retrieve**(`productCategoryId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a medusa product category", + "children": [ + { + "name": "AdminProductCategoriesCategoryRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +gets a product category + +___ + +### update + +▸ **update**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated medusa product category", + "children": [ + { + "name": "AdminProductCategoriesCategoryRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +updates a product category diff --git a/www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx b/www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx new file mode 100644 index 0000000000..e14ab0f36e --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx @@ -0,0 +1,52 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminProductTagsResource + +[admin/product-tags](../../modules/admin_product_tags.mdx).AdminProductTagsResource + +## Methods + +### list + +▸ **list**(`query?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductTagsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproducttagslistres)\> + +#### Parameters + + + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductTagsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproducttagslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductTagsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_tags`: [`ProductTag`](../../internal/classes/admin_collections.internal.ProductTag.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx b/www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx new file mode 100644 index 0000000000..323a770b85 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx @@ -0,0 +1,60 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminProductTypesResource + +[admin/product-types](../../modules/admin_product_types.mdx).AdminProductTypesResource + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductTypesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproducttypeslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductTypesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproducttypeslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductTypesListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_types`: [`ProductType`](../../internal/classes/admin_collections.internal.ProductType.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx b/www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx new file mode 100644 index 0000000000..fb8fccb904 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx @@ -0,0 +1,791 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminProductsResource + +[admin/products](../../modules/admin_products.mdx).AdminProductsResource + +## Methods + +### addOption + +▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### createVariant + +▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeleteres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeleteres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsDeleteRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteOption + +▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteOptionRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeleteoptionres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteOptionRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeleteoptionres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsDeleteOptionRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteVariant + +▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteVariantRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeletevariantres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteVariantRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeletevariantres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsDeleteVariantRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `products`: ([`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct) \\| [`Product`](../../internal/classes/admin_collections.internal.Product.mdx))[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### listTags + +▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListTagsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslisttagsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListTagsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslisttagsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsListTagsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### listTypes + +▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListTypesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslisttypesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListTypesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslisttypesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsListTypesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +Use AdminProductTypesResource.list instead. + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### setMetadata + +▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateOption + +▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateVariant + +▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminProductsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx b/www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx new file mode 100644 index 0000000000..27156eb762 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx @@ -0,0 +1,508 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPublishableApiKeyResource + +[admin/publishable-api-keys](../../modules/admin_publishable_api_keys.mdx).AdminPublishableApiKeyResource + +## Methods + +### addSalesChannelsBatch + +▸ **addSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPublishableApiKeysRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPublishableApiKeysRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteSalesChannelsBatch + +▸ **deleteSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPublishableApiKeysRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeyslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeyslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPublishableApiKeysListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `publishable_api_keys`: [`PublishableApiKey`](../../internal/classes/admin_discounts.internal.internal.PublishableApiKey.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### listSalesChannels + +▸ **listSalesChannels**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminSalesChannelsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../../internal/classes/admin_collections.internal.SalesChannel.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPublishableApiKeysRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### revoke + +▸ **revoke**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminPublishableApiKeysRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): `Promise`<`any`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx b/www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx new file mode 100644 index 0000000000..35679b6da1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx @@ -0,0 +1,725 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminRegionsResource + +[admin/regions](../../modules/admin_regions.mdx).AdminRegionsResource + +## Methods + +### addCountry + +▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated region", + "children": [ + { + "name": "AdminRegionsRes", + "type": "[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Description + +adds a country to the list of countries in a region + +___ + +### addFulfillmentProvider + +▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated region", + "children": [ + { + "name": "AdminRegionsRes", + "type": "[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Description + +adds a fulfillment provider to a region + +___ + +### addPaymentProvider + +▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated region", + "children": [ + { + "name": "AdminRegionsRes", + "type": "[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Description + +adds a payment provider to a region + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "created region.", + "children": [ + { + "name": "AdminRegionsRes", + "type": "[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Description + +creates a region. + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "Deleted response", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +deletes a region + +___ + +### deleteCountry + +▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated region", + "children": [ + { + "name": "AdminRegionsRes", + "type": "[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Description + +remove a country from a region's list of coutnries + +___ + +### deleteFulfillmentProvider + +▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated region", + "children": [ + { + "name": "AdminRegionsRes", + "type": "[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Description + +remove a fulfillment provider from a region + +___ + +### deletePaymentProvider + +▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated region", + "children": [ + { + "name": "AdminRegionsRes", + "type": "[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Description + +removes a payment provider from a region + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminregionslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminregionslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a list of regions matching the query.", + "children": [ + { + "name": "AdminRegionsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `regions`: [`Region`](../../internal/classes/admin_collections.internal.Region.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +lists regions matching a query + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the region with the given id", + "children": [ + { + "name": "AdminRegionsRes", + "type": "[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Description + +get a region + +___ + +### retrieveFulfillmentOptions + +▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminGetRegionsRegionFulfillmentOptionsRes.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminGetRegionsRegionFulfillmentOptionsRes.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "list of fulfillment options", + "children": [ + { + "name": "AdminGetRegionsRegionFulfillmentOptionsRes", + "type": "[`AdminGetRegionsRegionFulfillmentOptionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminGetRegionsRegionFulfillmentOptionsRes.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Description + +retrieves the list of fulfillment options available in a region + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated region.", + "children": [ + { + "name": "AdminRegionsRes", + "type": "[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Description + +updates a region diff --git a/www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx b/www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx new file mode 100644 index 0000000000..feae08f6eb --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx @@ -0,0 +1,312 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminReservationsResource + +[admin/reservations](../../modules/admin_reservations.mdx).AdminReservationsResource + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\> + +create a reservation + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the created reservation", + "children": [ + { + "name": "AdminReservationsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +create a reservation + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +remove a reservation + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "reservation removal confirmation", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +remove a reservation + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationslistres)\> + +List reservations + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "A list of reservations matching the provided query", + "children": [ + { + "name": "AdminReservationsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `reservations`: [`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Lists reservations + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\> + +Get a reservation + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "The reservation with the provided id", + "children": [ + { + "name": "AdminReservationsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +gets a reservation + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\> + +update a reservation + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "The updated reservation", + "children": [ + { + "name": "AdminReservationsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +update a reservation + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory diff --git a/www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx b/www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx new file mode 100644 index 0000000000..9cce92943a --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx @@ -0,0 +1,284 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminReturnReasonsResource + +[admin/return-reasons](../../modules/admin_return_reasons.mdx).AdminReturnReasonsResource + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "Created return reason.", + "children": [ + { + "name": "AdminReturnReasonsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Creates a return reason. + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "Deleted response", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +deletes a return reason + +___ + +### list + +▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a list of return reasons matching the query.", + "children": [ + { + "name": "AdminReturnReasonsListRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Lists return reasons matching a query + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the return reason with the given id", + "children": [ + { + "name": "AdminReturnReasonsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +retrieves a return reason + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated return reason.", + "children": [ + { + "name": "AdminReturnReasonsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Updates a return reason diff --git a/www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx b/www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx new file mode 100644 index 0000000000..4c37b79f6c --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx @@ -0,0 +1,182 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminReturnsResource + +[admin/returns](../../modules/admin_returns.mdx).AdminReturnsResource + +## Methods + +### cancel + +▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsCancelRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnscancelres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsCancelRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnscancelres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the order for which the return was canceled", + "children": [ + { + "name": "AdminReturnsCancelRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +cancels a return + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a list of returns matching the query", + "children": [ + { + "name": "AdminReturnsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `returns`: [`Return`](../../internal/classes/admin_collections.internal.Return.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +lists returns matching a query + +___ + +### receive + +▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the return", + "children": [ + { + "name": "AdminReturnsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +receive a return diff --git a/www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx b/www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx new file mode 100644 index 0000000000..1391f2aaea --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx @@ -0,0 +1,572 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminSalesChannelsResource + +[admin/sales-channels](../../modules/admin_sales_channels.mdx).AdminSalesChannelsResource + +## Methods + +### addLocation + +▸ **addLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> + +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. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the Medusa SalesChannel", + "children": [ + { + "name": "AdminSalesChannelsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Add a stock location to a SalesChannel + +___ + +### addProducts + +▸ **addProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a medusa sales channel", + "children": [ + { + "name": "AdminSalesChannelsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Add products to a sales channel + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminSalesChannelsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#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. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "an deletion result", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +gets a sales channel + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the list of sales channel as well as the pagination properties", + "children": [ + { + "name": "AdminSalesChannelsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../../internal/classes/admin_collections.internal.SalesChannel.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieve a list of sales channels + +___ + +### removeLocation + +▸ **removeLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "an deletion result", + "children": [ + { + "name": "AdminSalesChannelsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Remove a stock location from a SalesChannel + +___ + +### removeProducts + +▸ **removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a medusa sales channel", + "children": [ + { + "name": "AdminSalesChannelsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Remove products from a sales channel + +___ + +### retrieve + +▸ **retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a medusa sales channel", + "children": [ + { + "name": "AdminSalesChannelsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +gets a sales channel + +___ + +### update + +▸ **update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated medusa sales channel", + "children": [ + { + "name": "AdminSalesChannelsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +updates a sales channel diff --git a/www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx b/www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx new file mode 100644 index 0000000000..0184e22b2d --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx @@ -0,0 +1,292 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminShippingOptionsResource + +[admin/shipping-options](../../modules/admin_shipping_options.mdx).AdminShippingOptionsResource + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "created shipping option.", + "children": [ + { + "name": "AdminShippingOptionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +creates a shipping option. + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "deleted response", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +deletes a shipping option + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a list of shipping options matching the query.", + "children": [ + { + "name": "AdminShippingOptionsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../../internal/classes/admin_collections.internal.ShippingOption.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +lists shipping options matching a query + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the shipping option with the given id", + "children": [ + { + "name": "AdminShippingOptionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +get a shipping option + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated shipping option.", + "children": [ + { + "name": "AdminShippingOptionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +updates a shipping option diff --git a/www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx b/www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx new file mode 100644 index 0000000000..16911aa806 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx @@ -0,0 +1,264 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminShippingProfilesResource + +[admin/shipping-profiles](../../modules/admin_shipping_profiles.mdx).AdminShippingProfilesResource + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminShippingProfilesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofileslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofileslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminShippingProfilesListRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminShippingProfilesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminShippingProfilesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx b/www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx new file mode 100644 index 0000000000..74bea94a53 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx @@ -0,0 +1,312 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminStockLocationsResource + +[admin/stock-locations](../../modules/admin_stock_locations.mdx).AdminStockLocationsResource + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a medusa Stock Location", + "children": [ + { + "name": "AdminStockLocationsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +gets a medusa Stock Location + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +deletes a Stock Location + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the list of Stock Locations as well as the pagination properties", + "children": [ + { + "name": "AdminStockLocationsListRes", + "type": "[`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `stock_locations`: [`StockLocationExpandedDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationexpandeddto)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieve a list of Stock Locations + +___ + +### retrieve + +▸ **retrieve**(`itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a medusa Stock Location", + "children": [ + { + "name": "AdminStockLocationsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +gets a medusa Stock Location + +___ + +### update + +▸ **update**(`stockLocationId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated medusa Stock Location", + "children": [ + { + "name": "AdminStockLocationsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +updates a Stock Location diff --git a/www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx b/www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx new file mode 100644 index 0000000000..c28384ae79 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx @@ -0,0 +1,315 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminStoresResource + +[admin/store](../../modules/admin_store.mdx).AdminStoresResource + +## Methods + +### addCurrency + +▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated store.", + "children": [ + { + "name": "AdminStoresRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +adds a currency to the store. + +___ + +### deleteCurrency + +▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated store", + "children": [ + { + "name": "AdminStoresRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +deletes a currency from the available store currencies + +___ + +### listPaymentProviders + +▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentProvidersList`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentproviderslist)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentProvidersList`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentproviderslist)\> + +", + "optional": false, + "defaultValue": "", + "description": "a list of payment providers configured on the store", + "children": [ + { + "name": "AdminPaymentProvidersList", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Lists the store's payment providers + +___ + +### listTaxProviders + +▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxProvidersList`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxproviderslist)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxProvidersList`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxproviderslist)\> + +", + "optional": false, + "defaultValue": "", + "description": "a list of payment providers configured on the store", + "children": [ + { + "name": "AdminTaxProvidersList", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Lists the store's payment providers + +___ + +### retrieve + +▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminExtendedStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminextendedstoresres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminExtendedStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminextendedstoresres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a medusa store", + "children": [ + { + "name": "AdminExtendedStoresRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +gets a medusa store + +___ + +### update + +▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated store.", + "children": [ + { + "name": "AdminStoresRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Updates the store diff --git a/www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx b/www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx new file mode 100644 index 0000000000..2179b93bc6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx @@ -0,0 +1,111 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminSwapsResource + +[admin/swaps](../../modules/admin_swaps.mdx).AdminSwapsResource + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSwapsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminswapslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSwapsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminswapslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminSwapsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `swaps`: [`Swap`](../../internal/classes/admin_collections.internal.Swap.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminswapsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminswapsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminSwapsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx b/www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx new file mode 100644 index 0000000000..f38c6baaf2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx @@ -0,0 +1,698 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminTaxRatesResource + +[admin/tax-rates](../../modules/admin_tax_rates.mdx).AdminTaxRatesResource + +## Methods + +### addProductTypes + +▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminTaxRatesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### addProducts + +▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminTaxRatesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### addShippingOptions + +▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminTaxRatesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminTaxRatesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxrateslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxrateslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminTaxRatesListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `tax_rates`: [`TaxRate`](../../internal/classes/admin_collections.internal.TaxRate.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeProductTypes + +▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminTaxRatesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeProducts + +▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminTaxRatesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeShippingOptions + +▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminTaxRatesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminTaxRatesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminTaxRatesRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx b/www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx new file mode 100644 index 0000000000..e26f5f5b0f --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx @@ -0,0 +1,251 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminUploadsResource + +[admin/uploads](../../modules/admin_uploads.mdx).AdminUploadsResource + +## Properties + + + +## Methods + +### \_createPayload + +▸ `Private` **_createPayload**(`file`): `FormData` + +#### Parameters + + + +#### Returns + +`FormData` + + + +___ + +### create + +▸ **create**(`file`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\> + +#### Parameters + + + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "Uploaded file or files.", + "children": [ + { + "name": "AdminUploadsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Uploads at least one file to the specific fileservice that is installed in Medusa. + +___ + +### createProtected + +▸ **createProtected**(`file`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\> + +#### Parameters + + + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "Uploaded file or files.", + "children": [ + { + "name": "AdminUploadsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Uploads at least one file with ACL or a non-public bucket to the specific fileservice that is installed in Medusa. + +___ + +### delete + +▸ **delete**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### getPresignedDownloadUrl + +▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsDownloadUrlRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsdownloadurlres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsDownloadUrlRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsdownloadurlres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminUploadsDownloadUrlRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_uploads/modules/admin_uploads.internal.mdx b/www/apps/docs/content/references/js-client/admin_uploads/modules/admin_uploads.internal.mdx new file mode 100644 index 0000000000..4bd2b93620 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_uploads/modules/admin_uploads.internal.mdx @@ -0,0 +1,769 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +## Interfaces + +- [BlobPropertyBag](../../internal/interfaces/admin_uploads.internal.BlobPropertyBag.mdx) +- [File](../../internal/interfaces/admin_uploads.internal.File.mdx) +- [FilePropertyBag](../../internal/interfaces/admin_uploads.internal.FilePropertyBag.mdx) +- [QueuingStrategy](../../internal/interfaces/admin_uploads.internal.QueuingStrategy.mdx) +- [QueuingStrategySize](../../internal/interfaces/admin_uploads.internal.QueuingStrategySize.mdx) +- [ReadableByteStreamController](../../internal/interfaces/admin_uploads.internal.ReadableByteStreamController.mdx) +- [ReadableStream](../../internal/interfaces/admin_uploads.internal.ReadableStream.mdx) +- [ReadableStreamBYOBReader](../../internal/interfaces/admin_uploads.internal.ReadableStreamBYOBReader.mdx) +- [ReadableStreamBYOBRequest](../../internal/interfaces/admin_uploads.internal.ReadableStreamBYOBRequest.mdx) +- [ReadableStreamDefaultController](../../internal/interfaces/admin_uploads.internal.ReadableStreamDefaultController.mdx) +- [ReadableStreamDefaultReader](../../internal/interfaces/admin_uploads.internal.ReadableStreamDefaultReader.mdx) +- [ReadableStreamGenericReader](../../internal/interfaces/admin_uploads.internal.ReadableStreamGenericReader.mdx) +- [ReadableStreamGetReaderOptions](../../internal/interfaces/admin_uploads.internal.ReadableStreamGetReaderOptions.mdx) +- [ReadableStreamReadDoneResult](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadDoneResult.mdx) +- [ReadableStreamReadValueResult](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadValueResult.mdx) +- [ReadableWritablePair](../../internal/interfaces/admin_uploads.internal.ReadableWritablePair.mdx) +- [StreamPipeOptions](../../internal/interfaces/admin_uploads.internal.StreamPipeOptions.mdx) +- [UnderlyingByteSource](../../internal/interfaces/admin_uploads.internal.UnderlyingByteSource.mdx) +- [UnderlyingDefaultSource](../../internal/interfaces/admin_uploads.internal.UnderlyingDefaultSource.mdx) +- [UnderlyingSink](../../internal/interfaces/admin_uploads.internal.UnderlyingSink.mdx) +- [UnderlyingSinkAbortCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSinkAbortCallback.mdx) +- [UnderlyingSinkCloseCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSinkCloseCallback.mdx) +- [UnderlyingSinkStartCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSinkStartCallback.mdx) +- [UnderlyingSinkWriteCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSinkWriteCallback.mdx) +- [UnderlyingSource](../../internal/interfaces/admin_uploads.internal.UnderlyingSource.mdx) +- [UnderlyingSourceCancelCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSourceCancelCallback.mdx) +- [UnderlyingSourcePullCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSourcePullCallback.mdx) +- [UnderlyingSourceStartCallback](../../internal/interfaces/admin_uploads.internal.UnderlyingSourceStartCallback.mdx) +- [WritableStream](../../internal/interfaces/admin_uploads.internal.WritableStream.mdx) +- [WritableStreamDefaultController](../../internal/interfaces/admin_uploads.internal.WritableStreamDefaultController.mdx) +- [WritableStreamDefaultWriter](../../internal/interfaces/admin_uploads.internal.WritableStreamDefaultWriter.mdx) + +## Type Aliases + +### AdminCreateUploadPayload + +Ƭ **AdminCreateUploadPayload**: [`File`](admin_uploads.internal.mdx#file) \| [`File`](admin_uploads.internal.mdx#file)[] + +___ + +### BlobPart + +Ƭ **BlobPart**: [`BufferSource`](admin_uploads.internal.mdx#buffersource) \| `Blob` \| `string` + +___ + +### BufferSource + +Ƭ **BufferSource**: [`ArrayBufferView`](../../internal/interfaces/admin_discounts.internal.ArrayBufferView.mdx) \| `ArrayBuffer` + +___ + +### EndingType + +Ƭ **EndingType**: ``"native"`` \| ``"transparent"`` + +___ + +### ReadableStreamController + +Ƭ **ReadableStreamController**<`T`\>: [`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`T`\> \| [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller) + +#### Type parameters + + + +___ + +### ReadableStreamReadResult + +Ƭ **ReadableStreamReadResult**<`T`\>: [`ReadableStreamReadValueResult`](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadValueResult.mdx)<`T`\> \| [`ReadableStreamReadDoneResult`](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadDoneResult.mdx)<`T`\> + +#### Type parameters + + + +___ + +### ReadableStreamReader + +Ƭ **ReadableStreamReader**<`T`\>: [`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`T`\> \| [`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader) + +#### Type parameters + + + +## Variables + +### File + +• **File**: `Object` + +#### Call signature + +• **new File**(`fileBits`, `fileName`, `options?`): [`File`](admin_uploads.internal.mdx#file) + +##### Parameters + + + +##### Returns + +[`File`](admin_uploads.internal.mdx#file) + + + +#### Type declaration + + + +___ + +### ReadableByteStreamController + +• **ReadableByteStreamController**: `Object` + +#### Call signature + +• **new ReadableByteStreamController**(): [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller) + +##### Returns + +[`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller) + + [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Type declaration + + + +___ + +### ReadableStream + +• **ReadableStream**: `Object` + +#### Call signature + +• **new ReadableStream**(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`Uint8Array`\> + +##### Parameters + + + +##### Returns + +[`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`Uint8Array`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Uint8Array", + "type": "`Uint8Array`", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +• **new ReadableStream**<`R`\>(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\> + + + +##### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "strategy", + "type": "[`QueuingStrategy`](../../internal/interfaces/admin_uploads.internal.QueuingStrategy.mdx)<`R`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +[`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +• **new ReadableStream**<`R`\>(`underlyingSource?`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\> + + + +##### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "strategy", + "type": "[`QueuingStrategy`](../../internal/interfaces/admin_uploads.internal.QueuingStrategy.mdx)<`R`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +[`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### ReadableStreamBYOBReader + +• **ReadableStreamBYOBReader**: `Object` + +#### Call signature + +• **new ReadableStreamBYOBReader**(`stream`): [`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader) + +##### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +[`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader) + +) => [`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Type declaration + + + +___ + +### ReadableStreamBYOBRequest + +• **ReadableStreamBYOBRequest**: `Object` + +#### Call signature + +• **new ReadableStreamBYOBRequest**(): [`ReadableStreamBYOBRequest`](admin_uploads.internal.mdx#readablestreambyobrequest) + +##### Returns + +[`ReadableStreamBYOBRequest`](admin_uploads.internal.mdx#readablestreambyobrequest) + + [`ReadableStreamBYOBRequest`](admin_uploads.internal.mdx#readablestreambyobrequest)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Type declaration + + + +___ + +### ReadableStreamDefaultController + +• **ReadableStreamDefaultController**: `Object` + +#### Call signature + +• **new ReadableStreamDefaultController**(): [`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`any`\> + +##### Returns + +[`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### ReadableStreamDefaultReader + +• **ReadableStreamDefaultReader**: `Object` + +#### Call signature + +• **new ReadableStreamDefaultReader**<`R`\>(`stream`): [`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\> + + + +##### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +[`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### WritableStream + +• **WritableStream**: `Object` + +#### Call signature + +• **new WritableStream**<`W`\>(`underlyingSink?`, `strategy?`): [`WritableStream`](admin_uploads.internal.mdx#writablestream)<`W`\> + + + +##### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "strategy", + "type": "[`QueuingStrategy`](../../internal/interfaces/admin_uploads.internal.QueuingStrategy.mdx)<`W`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +[`WritableStream`](admin_uploads.internal.mdx#writablestream)<`W`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### WritableStreamDefaultController + +• **WritableStreamDefaultController**: `Object` + +#### Call signature + +• **new WritableStreamDefaultController**(): [`WritableStreamDefaultController`](admin_uploads.internal.mdx#writablestreamdefaultcontroller) + +##### Returns + +[`WritableStreamDefaultController`](admin_uploads.internal.mdx#writablestreamdefaultcontroller) + + [`WritableStreamDefaultController`](admin_uploads.internal.mdx#writablestreamdefaultcontroller)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Type declaration + + + +___ + +### WritableStreamDefaultWriter + +• **WritableStreamDefaultWriter**: `Object` + +#### Call signature + +• **new WritableStreamDefaultWriter**<`W`\>(`stream`): [`WritableStreamDefaultWriter`](admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\> + + + +##### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +[`WritableStreamDefaultWriter`](admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/admin_users/classes/admin_users.AdminUsersResource.mdx b/www/apps/docs/content/references/js-client/admin_users/classes/admin_users.AdminUsersResource.mdx new file mode 100644 index 0000000000..24e1edd2c6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_users/classes/admin_users.AdminUsersResource.mdx @@ -0,0 +1,383 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminUsersResource + +[admin/users](../../modules/admin_users.mdx).AdminUsersResource + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> + +", + "optional": false, + "defaultValue": "", + "description": "created user", + "children": [ + { + "name": "AdminUserRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +creates a user with the provided information + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "delete response", + "children": [ + { + "name": "DeleteResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +deletes a user + +___ + +### list + +▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUsersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUsersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "a list of all users", + "children": [ + { + "name": "AdminUsersListRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +lists all users + +___ + +### resetPassword + +▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminUserRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +resets the users password given the correct token. + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> + +Retrieves a given user + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the user", + "children": [ + { + "name": "AdminUserRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### sendResetPasswordToken + +▸ **sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Description + +resets password by re-sending password token. + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated user", + "children": [ + { + "name": "AdminUserRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +updates a given user diff --git a/www/apps/docs/content/references/js-client/admin_users/modules/admin_users.internal.mdx b/www/apps/docs/content/references/js-client/admin_users/modules/admin_users.internal.mdx new file mode 100644 index 0000000000..011fd4b363 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_users/modules/admin_users.internal.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +## Type Aliases + +### AdminCreateUserPayload + +Ƭ **AdminCreateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx), ``"role"``\> \| { `role?`: [`CreateUserRoles`](admin_users.internal.mdx#createuserroles) } + +___ + +### AdminUpdateUserPayload + +Ƭ **AdminUpdateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx), ``"role"``\> & { `role?`: [`UpdateUserRoles`](admin_users.internal.mdx#updateuserroles) } + +___ + +### CreateUserRoles + +Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\` + +___ + +### CreateUserRolesEnum + +Ƭ **CreateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx)[``"role"``]\> + +___ + +### NoUndefined + +Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T` + +#### Type parameters + + + +___ + +### UpdateUserRoles + +Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\` + +___ + +### UpdateUserRolesEnum + +Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx)[``"role"``]\> diff --git a/www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx b/www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx new file mode 100644 index 0000000000..5dbe482818 --- /dev/null +++ b/www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx @@ -0,0 +1,174 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminVariantsResource + +[admin/variants](../../modules/admin_variants.mdx).AdminVariantsResource + +## Methods + +### getInventory + +▸ **getInventory**(`variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingetvariantsvariantinventoryres)\> + +#### Parameters + +", + "description": "custom headers", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingetvariantsvariantinventoryres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AdminGetVariantsVariantInventoryRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminVariantsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminvariantslistres)\> + +List product variants + +#### Parameters + +", + "description": "custom headers", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminVariantsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminvariantslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "A list of variants satisfying the criteria of the query", + "children": [ + { + "name": "AdminVariantsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `variants`: [`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminVariantsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminvariantsres)\> + +Get a product variant + +#### Parameters + +", + "description": "custom headers", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminVariantsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminvariantsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "A list of variants satisfying the criteria of the query", + "children": [ + { + "name": "AdminVariantsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx b/www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx new file mode 100644 index 0000000000..b1965f932c --- /dev/null +++ b/www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx @@ -0,0 +1,260 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AuthResource + +[auth](../../modules/auth.mdx).AuthResource + +## Methods + +### authenticate + +▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeauthres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeauthres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreAuthRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Authenticates a customer using email and password combination + +___ + +### deleteSession + +▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Description + +Removes authentication session + +___ + +### exists + +▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetAuthEmailRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetauthemailres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetAuthEmailRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetauthemailres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreGetAuthEmailRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Check if email exists + +___ + +### getSession + +▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeauthres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeauthres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreAuthRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves an authenticated session +Usually used to check if authenticated session is alive. + +___ + +### getToken + +▸ **getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreBearerAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storebearerauthres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreBearerAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storebearerauthres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreBearerAuthRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a new JWT access token diff --git a/www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx b/www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx new file mode 100644 index 0000000000..ff0a6694ba --- /dev/null +++ b/www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx @@ -0,0 +1,676 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CartsResource + +[carts](../../modules/carts.mdx).CartsResource + +## Properties + + + +## Methods + +### addShippingMethod + +▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +Adds a shipping method to cart + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCartsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### complete + +▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCompleteCartRes`](../../internal/modules/admin_discounts.internal.internal.mdx#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 provided, we will generate one for the request. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCompleteCartRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecompletecartres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCompleteCartRes", + "type": "{ `data`: [`Cart`](../../internal/classes/admin_collections.internal.Cart.mdx) ; `type`: ``\"cart\"`` } \\| { `data`: [`Order`](../../internal/classes/admin_collections.internal.Order.mdx) ; `type`: ``\"order\"`` } \\| { `data`: [`Swap`](../../internal/classes/admin_collections.internal.Swap.mdx) ; `type`: ``\"swap\"`` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +Creates a cart + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCartsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### createPaymentSessions + +▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +Creates payment sessions. +Initializes the payment sessions that can be used to pay for the items of the cart. +This is usually called when a customer proceeds to checkout. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCartsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteDiscount + +▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +Removes a discount from cart. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCartsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### deletePaymentSession + +▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +Removes a payment session from a cart. +Can be useful in case a payment has failed + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCartsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### refreshPaymentSession + +▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +Refreshes a payment session. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCartsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +Retrieves a cart + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCartsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### setPaymentSession + +▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +Refreshes a payment session. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCartsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +Updates a cart + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCartsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### updatePaymentSession + +▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +Updates the payment method + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCartsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/classes/AddressesResource.md b/www/apps/docs/content/references/js-client/classes/AddressesResource.md deleted file mode 100644 index b9d1ca3092..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AddressesResource.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AddressesResource - -## Hierarchy - -- `default` - - ↳ **`AddressesResource`** - -## Methods - -### addAddress - -▸ **addAddress**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -Adds an address to a customers saved addresses - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | [`StorePostCustomersCustomerAddressesReq`](internal.StorePostCustomersCustomerAddressesReq.md) | contains information to create an address | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -Deletes an address of a customer - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `address_id` | `string` | id of the address to delete | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -Update an address of a customer - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `address_id` | `string` | id of customer | -| `payload` | [`StorePostCustomersCustomerAddressesAddressReq`](internal.StorePostCustomersCustomerAddressesAddressReq.md) | address update | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -#### Defined in - -[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 deleted file mode 100644 index a41c33ad1f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/Admin.md +++ /dev/null @@ -1,391 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Admin - -## Hierarchy - -- `default` - - ↳ **`Admin`** - -## Properties - -### auth - -• **auth**: [`AdminAuthResource`](AdminAuthResource.md) - -#### Defined in - -[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) - -___ - -### batchJobs - -• **batchJobs**: [`AdminBatchJobsResource`](AdminBatchJobsResource.md) - -#### Defined in - -[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) - -___ - -### collections - -• **collections**: [`AdminCollectionsResource`](AdminCollectionsResource.md) - -#### Defined in - -[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) - -___ - -### currencies - -• **currencies**: [`AdminCurrenciesResource`](AdminCurrenciesResource.md) - -#### Defined in - -[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) - -___ - -### customerGroups - -• **customerGroups**: [`AdminCustomerGroupsResource`](AdminCustomerGroupsResource.md) - -#### Defined in - -[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) - -___ - -### customers - -• **customers**: [`AdminCustomersResource`](AdminCustomersResource.md) - -#### Defined in - -[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) - -___ - -### discounts - -• **discounts**: [`AdminDiscountsResource`](AdminDiscountsResource.md) - -#### Defined in - -[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) - -___ - -### draftOrders - -• **draftOrders**: [`AdminDraftOrdersResource`](AdminDraftOrdersResource.md) - -#### Defined in - -[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) - -___ - -### giftCards - -• **giftCards**: [`AdminGiftCardsResource`](AdminGiftCardsResource.md) - -#### Defined in - -[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) - -___ - -### invites - -• **invites**: [`AdminInvitesResource`](AdminInvitesResource.md) - -#### Defined in - -[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) - -___ - -### notes - -• **notes**: [`AdminNotesResource`](AdminNotesResource.md) - -#### Defined in - -[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) - -___ - -### notifications - -• **notifications**: [`AdminNotificationsResource`](AdminNotificationsResource.md) - -#### Defined in - -[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) - -___ - -### orderEdits - -• **orderEdits**: [`AdminOrderEditsResource`](AdminOrderEditsResource.md) - -#### Defined in - -[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) - -___ - -### orders - -• **orders**: [`AdminOrdersResource`](AdminOrdersResource.md) - -#### Defined in - -[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) - -___ - -### paymentCollections - -• **paymentCollections**: [`AdminPaymentCollectionsResource`](AdminPaymentCollectionsResource.md) - -#### Defined in - -[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) - -___ - -### payments - -• **payments**: [`AdminPaymentsResource`](AdminPaymentsResource.md) - -#### Defined in - -[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) - -___ - -### priceLists - -• **priceLists**: [`AdminPriceListResource`](AdminPriceListResource.md) - -#### Defined in - -[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) - -___ - -### productTags - -• **productTags**: [`AdminProductTagsResource`](AdminProductTagsResource.md) - -#### Defined in - -[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) - -___ - -### productTypes - -• **productTypes**: [`AdminProductTypesResource`](AdminProductTypesResource.md) - -#### Defined in - -[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) - -___ - -### products - -• **products**: [`AdminProductsResource`](AdminProductsResource.md) - -#### Defined in - -[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) - -___ - -### publishableApiKeys - -• **publishableApiKeys**: [`AdminPublishableApiKeyResource`](AdminPublishableApiKeyResource.md) - -#### Defined in - -[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) - -___ - -### regions - -• **regions**: [`AdminRegionsResource`](AdminRegionsResource.md) - -#### Defined in - -[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) - -___ - -### returnReasons - -• **returnReasons**: [`AdminReturnReasonsResource`](AdminReturnReasonsResource.md) - -#### Defined in - -[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) - -___ - -### returns - -• **returns**: [`AdminReturnsResource`](AdminReturnsResource.md) - -#### Defined in - -[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) - -___ - -### salesChannels - -• **salesChannels**: [`AdminSalesChannelsResource`](AdminSalesChannelsResource.md) - -#### Defined in - -[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) - -___ - -### shippingOptions - -• **shippingOptions**: [`AdminShippingOptionsResource`](AdminShippingOptionsResource.md) - -#### Defined in - -[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) - -___ - -### shippingProfiles - -• **shippingProfiles**: [`AdminShippingProfilesResource`](AdminShippingProfilesResource.md) - -#### Defined in - -[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) - -___ - -### store - -• **store**: [`AdminStoresResource`](AdminStoresResource.md) - -#### Defined in - -[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) - -___ - -### swaps - -• **swaps**: [`AdminSwapsResource`](AdminSwapsResource.md) - -#### Defined in - -[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) - -___ - -### taxRates - -• **taxRates**: [`AdminTaxRatesResource`](AdminTaxRatesResource.md) - -#### Defined in - -[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) - -___ - -### uploads - -• **uploads**: [`AdminUploadsResource`](AdminUploadsResource.md) - -#### Defined in - -[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) - -___ - -### users - -• **users**: [`AdminUsersResource`](AdminUsersResource.md) - -#### Defined in - -[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) - -___ - -### variants - -• **variants**: [`AdminVariantsResource`](AdminVariantsResource.md) - -#### Defined in - -[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 deleted file mode 100644 index dbabb43408..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminAuthResource.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminAuthResource - -## Hierarchy - -- `default` - - ↳ **`AdminAuthResource`** - -## Methods - -### createSession - -▸ **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`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\> - -**`Description`** - -Creates an authenticated session - -#### Defined in - -[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-12.md#responsepromise)<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\> - -**`Description`** - -destroys an authenticated session - -#### Defined in - -[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-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 | -| :------ | :------ | -| `payload` | [`AdminPostAuthReq`](internal-1.AdminPostAuthReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBearerAuthRes`](../modules/internal-1.md#adminbearerauthres)\> - -**`Description`** - -Retrieves a new JWT access token - -#### Defined in - -[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 deleted file mode 100644 index adc00c6d33..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminBatchJobsResource - -## Hierarchy - -- `default` - - ↳ **`AdminBatchJobsResource`** - -## Methods - -### cancel - -▸ **cancel**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `batchJobId` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `batchJobId` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostBatchesReq`](internal-2.AdminPostBatchesReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminBatchJobListRes`](../modules/internal-2.md#adminbatchjoblistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetBatchParams`](internal-2.AdminGetBatchParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobListRes`](../modules/internal-2.md#adminbatchjoblistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `batchJobId` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> - -#### Defined in - -[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 deleted file mode 100644 index 6d9dd8ff71..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminCollectionsResource.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminCollectionsResource - -## Hierarchy - -- `default` - - ↳ **`AdminCollectionsResource`** - -## Methods - -### addProducts - -▸ **addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> - -**`Description`** - -Updates products associated with a Product Collection - -#### Defined in - -[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-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostCollectionsReq`](internal-3.AdminPostCollectionsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> - -Created collection. - -**`Description`** - -Creates a collection. - -#### Defined in - -[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-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | id of collection to delete. | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> - -Deleted response - -**`Description`** - -deletes a collection - -#### Defined in - -[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-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`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`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 - -[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-12.md#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/internal-3.md#admindeleteproductsfromcollectionres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/internal-3.md#admindeleteproductsfromcollectionres)\> - -**`Description`** - -Removes products associated with a Product Collection - -#### Defined in - -[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-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | id of the collection to retrieve. | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> - -the collection with the given id - -**`Description`** - -get a collection - -#### Defined in - -[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-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | id of the collection to update. | -| `payload` | [`AdminPostCollectionsCollectionReq`](internal-3.AdminPostCollectionsCollectionReq.md) | update to apply to collection. | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> - -the updated collection. - -**`Description`** - -Updates a collection - -#### Defined in - -[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 deleted file mode 100644 index 69d29dc8e8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminCurrenciesResource - -## Hierarchy - -- `default` - - ↳ **`AdminCurrenciesResource`** - -## Methods - -### list - -▸ **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`** - -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. - -#### Defined in - -[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-12.md#responsepromise)<[`AdminCurrenciesRes`](../modules/internal-4.md#admincurrenciesres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `code` | `string` | code of the currency to update. | -| `payload` | [`AdminPostCurrenciesCurrencyReq`](internal-4.AdminPostCurrenciesCurrencyReq.md) | update to apply to currency. | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`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 - -[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 deleted file mode 100644 index dac8453265..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminCustomResource.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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 deleted file mode 100644 index 1f08663f63..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminCustomerGroupsResource - -## Hierarchy - -- `default` - - ↳ **`AdminCustomerGroupsResource`** - -## Methods - -### addCustomers - -▸ **addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> - -Add multiple customers to a customer group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | customer group id | -| `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-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> - -Create a customer group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | [`AdminPostCustomerGroupsReq`](internal-6.AdminPostCustomerGroupsReq.md) | customer group info | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> - -Deletes a customer group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | id of the customer group | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-6.md#admincustomergroupslistres)\> - -Lists customer groups. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `query?` | [`AdminGetCustomerGroupsParams`](internal-6.AdminGetCustomerGroupsParams.md) | optional | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-6.md#admincustomergroupslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-7.md#admincustomerslistres)\> - -List and count customers that belong to provided customer groups. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | customer group id | -| `query?` | [`AdminGetCustomersParams`](internal-7.AdminGetCustomersParams.md) | params for filtering customers | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-7.md#admincustomerslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> - -Remove multiple customers from a customer group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | customer group id | -| `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-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> - -Retrieves a customer group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | customer group id | -| `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-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> - -Updates a customer group - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | customer group id | -| `payload` | [`AdminPostCustomerGroupsGroupReq`](internal-6.AdminPostCustomerGroupsGroupReq.md) | data to update customer group with | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> - -#### Defined in - -[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 deleted file mode 100644 index 660a185194..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminCustomersResource.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminCustomersResource - -## Hierarchy - -- `default` - - ↳ **`AdminCustomersResource`** - -## Methods - -### create - -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\> - -Creates a customer - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | [`AdminPostCustomersReq`](internal-7.AdminPostCustomersReq.md) | information of customer | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-7.md#admincustomerslistres)\> - -Lists customers - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `query?` | [`AdminGetCustomersParams`](internal-7.AdminGetCustomersParams.md) | optional | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-7.md#admincustomerslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\> - -Retrieves a customer - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | customer id | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\> - -Updates a customer - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | customer id | -| `payload` | [`AdminPostCustomersCustomerReq`](internal-7.AdminPostCustomersCustomerReq.md) | data to update customer with | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\> - -#### Defined in - -[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 deleted file mode 100644 index 1657ff6a41..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminDiscountsResource.md +++ /dev/null @@ -1,429 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminDiscountsResource - -## Hierarchy - -- `default` - - ↳ **`AdminDiscountsResource`** - -## Methods - -### addConditionResourceBatch - -▸ **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 - -#### Defined in - -[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-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 - -#### Defined in - -[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-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 - -#### Defined in - -[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-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 - -#### Defined in - -[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-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 - -#### Defined in - -[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-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`** - -Deletes a discount - -#### Defined in - -[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-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 - -#### Defined in - -[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-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `discountId` | `string` | -| `conditionId` | `string` | -| `payload` | [`AdminDeleteDiscountsDiscountConditionsConditionBatchReq`](internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> - -**`Description`** - -Delete a batch of items from a discount condition - -#### Defined in - -[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-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `code` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> - -**`Description`** - -Deletes a dynamic discount - -#### Defined in - -[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-12.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-8.md#admindiscountconditionsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `discountId` | `string` | -| `conditionId` | `string` | -| `query?` | [`AdminGetDiscountsDiscountConditionsConditionParams`](internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-8.md#admindiscountconditionsres)\> - -**`Description`** - -Gets a condition from a discount - -#### Defined in - -[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-12.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-8.md#admindiscountslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetDiscountsParams`](internal-8.AdminGetDiscountsParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-8.md#admindiscountslistres)\> - -**`Description`** - -Lists discounts - -#### Defined in - -[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-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`** - -Removes a region from a discount - -#### Defined in - -[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-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> - -**`Description`** - -Retrieves a discount - -#### Defined in - -[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-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `code` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> - -**`Description`** - -Retrieves a discount by code - -#### Defined in - -[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-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostDiscountsDiscountReq`](internal-8.AdminPostDiscountsDiscountReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> - -**`Description`** - -Updates discount - -#### Defined in - -[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-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `discountId` | `string` | -| `conditionId` | `string` | -| `payload` | [`AdminPostDiscountsDiscountConditionsCondition`](internal-8.AdminPostDiscountsDiscountConditionsCondition.md) | -| `query` | [`AdminPostDiscountsDiscountConditionsConditionParams`](internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> - -**`Description`** - -Updates a discount condition - -#### Defined in - -[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 deleted file mode 100644 index de3f9cf731..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminDraftOrdersResource.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminDraftOrdersResource - -## Hierarchy - -- `default` - - ↳ **`AdminDraftOrdersResource`** - -## Methods - -### addLineItem - -▸ **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 - -#### Defined in - -[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-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 - -#### Defined in - -[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-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 - -#### Defined in - -[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-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 - -#### Defined in - -[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-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 - -#### Defined in - -[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-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 - -#### Defined in - -[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-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 - -#### Defined in - -[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-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal-8.internal.AdminPostDraftOrdersDraftOrderReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> - -**`Description`** - -Update draft order - -#### Defined in - -[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-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `itemId` | `string` | -| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsItemReq`](internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> - -**`Description`** - -Update draft order line item - -#### Defined in - -[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 deleted file mode 100644 index a4783beed4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGiftCardsResource - -## Hierarchy - -- `default` - - ↳ **`AdminGiftCardsResource`** - -## Methods - -### create - -▸ **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 - -#### Defined in - -[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-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`** - -Deletes a gift card - -#### Defined in - -[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-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 - -#### Defined in - -[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-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 - -#### Defined in - -[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-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal-8.internal.AdminPostGiftCardsGiftCardReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\> - -**`Description`** - -Updates a gift card - -#### Defined in - -[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 deleted file mode 100644 index 816e7b240e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminInventoryItemsResource.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -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 deleted file mode 100644 index 8b2da86ec4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminInvitesResource.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminInvitesResource - -## Hierarchy - -- `default` - - ↳ **`AdminInvitesResource`** - -## Methods - -### accept - -▸ **accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostInvitesInviteAcceptReq`](internal-8.internal.AdminPostInvitesInviteAcceptReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise) - -#### Defined in - -[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-12.md#responsepromise) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostInvitesPayload`](../modules/internal-9.md#adminpostinvitespayload) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise) - -#### Defined in - -[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-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)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-8.internal.md#adminlistinvitesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-8.internal.md#adminlistinvitesres)\> - -#### Defined in - -[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-12.md#responsepromise) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise) - -#### Defined in - -[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 deleted file mode 100644 index b53a360cac..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminNotesResource.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminNotesResource - -## Hierarchy - -- `default` - - ↳ **`AdminNotesResource`** - -## Methods - -### create - -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostNotesReq`](internal-8.internal.AdminPostNotesReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\> - -#### Defined in - -[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-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)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-8.internal.md#adminnoteslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetNotesParams`](internal-8.internal.AdminGetNotesParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-8.internal.md#adminnoteslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostNotesNoteReq`](internal-8.internal.AdminPostNotesNoteReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\> - -#### Defined in - -[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 deleted file mode 100644 index effb8468bf..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminNotificationsResource - -## Hierarchy - -- `default` - - ↳ **`AdminNotificationsResource`** - -## Methods - -### list - -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-8.internal.md#adminnotificationslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetNotificationsParams`](internal-8.internal.AdminGetNotificationsParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-8.internal.md#adminnotificationslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-8.internal.md#adminnotificationsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostNotificationsNotificationResendReq`](internal-8.internal.AdminPostNotificationsNotificationResendReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-8.internal.md#adminnotificationsres)\> - -#### Defined in - -[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 deleted file mode 100644 index 502a6290c9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminOrderEditsResource - -## Hierarchy - -- `default` - - ↳ **`AdminOrderEditsResource`** - -## Methods - -### addLineItem - -▸ **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-8.internal.AdminPostOrderEditsEditLineItemsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostOrderEditsReq`](internal-8.internal.AdminPostOrderEditsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Defined in - -[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-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)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../modules/internal-8.internal.md#adminorderedititemchangedeleteres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `orderEditId` | `string` | -| `itemChangeId` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../modules/internal-8.internal.md#adminorderedititemchangedeleteres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrderEditsListRes`](../modules/internal-8.internal.md#adminordereditslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`GetOrderEditsParams`](internal-8.internal.GetOrderEditsParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsListRes`](../modules/internal-8.internal.md#adminordereditslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `orderEditId` | `string` | -| `itemId` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `query?` | [`GetOrderEditsOrderEditParams`](internal-8.internal.GetOrderEditsOrderEditParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostOrderEditsOrderEditReq`](internal-8.internal.AdminPostOrderEditsOrderEditReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `orderEditId` | `string` | -| `itemId` | `string` | -| `payload` | [`AdminPostOrderEditsEditLineItemsLineItemReq`](internal-8.internal.AdminPostOrderEditsEditLineItemsLineItemReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> - -#### Defined in - -[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 deleted file mode 100644 index abfec3267e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminOrdersResource.md +++ /dev/null @@ -1,563 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminOrdersResource - -## Hierarchy - -- `default` - - ↳ **`AdminOrdersResource`** - -## Methods - -### addShippingMethod - -▸ **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-8.internal.AdminPostOrdersOrderShippingMethodsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `claimId` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `claimId` | `string` | -| `fulfillmentId` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `fulfillmentId` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `swapId` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `swapId` | `string` | -| `fulfillmentId` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostOrdersOrderClaimsReq`](internal-8.internal.AdminPostOrdersOrderClaimsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `claimId` | `string` | -| `payload` | [`AdminPostOrdersOrderClaimsClaimShipmentsReq`](internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostOrdersOrderFulfillmentsReq`](internal-8.internal.AdminPostOrdersOrderFulfillmentsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostOrdersOrderShipmentReq`](internal-8.internal.AdminPostOrdersOrderShipmentReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostOrdersOrderSwapsReq`](internal-8.internal.AdminPostOrdersOrderSwapsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `swapId` | `string` | -| `payload` | [`AdminPostOrdersOrderSwapsSwapShipmentsReq`](internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `claimId` | `string` | -| `payload` | [`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `swapId` | `string` | -| `payload` | [`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-8.internal.md#adminorderslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetOrdersParams`](internal-8.internal.AdminGetOrdersParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-8.internal.md#adminorderslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `swapId` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostOrdersOrderRefundsReq`](internal-8.internal.AdminPostOrdersOrderRefundsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostOrdersOrderReturnsReq`](internal-8.internal.AdminPostOrdersOrderReturnsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `query?` | [`FindParams`](internal-6.FindParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostOrdersOrderReq`](internal-8.internal.AdminPostOrdersOrderReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `claimId` | `string` | -| `payload` | [`AdminPostOrdersOrderClaimsClaimReq`](internal-8.internal.AdminPostOrdersOrderClaimsClaimReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> - -#### Defined in - -[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 deleted file mode 100644 index 96fdbe4498..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPaymentCollectionsResource - -## Hierarchy - -- `default` - - ↳ **`AdminPaymentCollectionsResource`** - -## Methods - -### delete - -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../modules/internal-8.internal.md#adminpaymentcollectiondeleteres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../modules/internal-8.internal.md#adminpaymentcollectiondeleteres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `query?` | [`AdminGetPaymentCollectionsParams`](internal-8.internal.AdminGetPaymentCollectionsParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminUpdatePaymentCollectionsReq`](internal-8.internal.AdminUpdatePaymentCollectionsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\> - -#### Defined in - -[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 deleted file mode 100644 index 9ec1419054..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPaymentsResource - -## Hierarchy - -- `default` - - ↳ **`AdminPaymentsResource`** - -## Methods - -### capturePayment - -▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-8.internal.md#adminpaymentres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-8.internal.md#adminpaymentres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminRefundRes`](../modules/internal-8.internal.md#adminrefundres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostPaymentRefundsReq`](internal-8.internal.AdminPostPaymentRefundsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRefundRes`](../modules/internal-8.internal.md#adminrefundres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-8.internal.md#adminpaymentres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `query?` | [`GetPaymentsParams`](internal-8.internal.GetPaymentsParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-8.internal.md#adminpaymentres)\> - -#### Defined in - -[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 deleted file mode 100644 index 203d74320e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminPriceListResource.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPriceListResource - -## Hierarchy - -- `default` - - ↳ **`AdminPriceListResource`** - -## Methods - -### addPrices - -▸ **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-8.internal.AdminPostPriceListPricesPricesReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostPriceListsPriceListReq`](internal-8.internal.AdminPostPriceListsPriceListReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> - -#### Defined in - -[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-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)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-8.internal.AdminDeletePriceListPricesPricesReq.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: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-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `priceListId` | `string` | -| `productId` | `string` | -| `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: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-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `priceListId` | `string` | -| `variantId` | `string` | -| `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: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-12.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-8.internal.md#adminpricelistslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetPriceListPaginationParams`](internal-8.internal.AdminGetPriceListPaginationParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-8.internal.md#adminpricelistslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-8.internal.AdminGetPriceListsPriceListProductsParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`any`\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-8.internal.AdminPostPriceListsPriceListPriceListReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> - -#### Defined in - -[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 deleted file mode 100644 index f2a45ac19f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminProductCategoriesResource.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -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 deleted file mode 100644 index 7a4d3ba153..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminProductTagsResource.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminProductTagsResource - -## Hierarchy - -- `default` - - ↳ **`AdminProductTagsResource`** - -## Methods - -### list - -▸ **list**(`query?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-8.internal.md#adminproducttagslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetProductTagsParams`](internal-8.internal.AdminGetProductTagsParams.md) | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-8.internal.md#adminproducttagslistres)\> - -#### Defined in - -[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 deleted file mode 100644 index 7c6c9ea304..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminProductTypesResource.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminProductTypesResource - -## Hierarchy - -- `default` - - ↳ **`AdminProductTypesResource`** - -## Methods - -### list - -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-8.internal.md#adminproducttypeslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetProductTypesParams`](internal-8.internal.AdminGetProductTypesParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-8.internal.md#adminproducttypeslistres)\> - -#### Defined in - -[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 deleted file mode 100644 index c453bb49c7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminProductsResource.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminProductsResource - -## Hierarchy - -- `default` - - ↳ **`AdminProductsResource`** - -## Methods - -### addOption - -▸ **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-8.internal.AdminPostProductsProductOptionsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostProductsReq`](internal-8.internal.AdminPostProductsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostProductsProductVariantsReq`](internal-8.internal.AdminPostProductsProductVariantsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-8.internal.md#adminproductsdeleteres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-8.internal.md#adminproductsdeleteres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-8.internal.md#adminproductsdeleteoptionres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `optionId` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-8.internal.md#adminproductsdeleteoptionres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-8.internal.md#adminproductsdeletevariantres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `variantId` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-8.internal.md#adminproductsdeletevariantres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-8.internal.md#adminproductslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetProductsParams`](internal-8.internal.AdminGetProductsParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-8.internal.md#adminproductslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-8.internal.md#adminproductslisttagsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-8.internal.md#adminproductslisttagsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-8.internal.md#adminproductslisttypesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-8.internal.md#adminproductslisttypesres)\> - -**`Deprecated`** - -Use [AdminProductTypesResource.list](AdminProductTypesResource.md#list) instead. - -#### Defined in - -[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-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostProductsProductMetadataReq`](internal-8.internal.AdminPostProductsProductMetadataReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostProductsProductReq`](internal-8.internal.AdminPostProductsProductReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `optionId` | `string` | -| `payload` | [`AdminPostProductsProductOptionsOption`](internal-8.internal.AdminPostProductsProductOptionsOption.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `variantId` | `string` | -| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-8.internal.AdminPostProductsProductVariantsVariantReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> - -#### Defined in - -[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 deleted file mode 100644 index 37cb6930e9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPublishableApiKeyResource - -## Hierarchy - -- `default` - - ↳ **`AdminPublishableApiKeyResource`** - -## Methods - -### addSalesChannelsBatch - -▸ **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-8.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostPublishableApiKeysReq`](internal-8.internal.AdminPostPublishableApiKeysReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> - -#### Defined in - -[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-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)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminDeletePublishableApiKeySalesChannelsBatchReq`](internal-8.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminPublishableApiKeysListRes`](../modules/internal-8.internal.md#adminpublishableapikeyslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`GetPublishableApiKeysParams`](internal-8.internal.GetPublishableApiKeysParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysListRes`](../modules/internal-8.internal.md#adminpublishableapikeyslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-8.internal.md#adminsaleschannelslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `query?` | [`GetPublishableApiKeySalesChannelsParams`](internal-8.internal.GetPublishableApiKeySalesChannelsParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-8.internal.md#adminsaleschannelslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `query?` | `Object` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> - -#### Defined in - -[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) - -___ - -### update - -▸ **update**(`id`, `payload`, `customHeaders?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostPublishableApiKeysPublishableApiKeyReq`](internal-8.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[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 deleted file mode 100644 index b6f9e65076..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminRegionsResource.md +++ /dev/null @@ -1,342 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminRegionsResource - -## Hierarchy - -- `default` - - ↳ **`AdminRegionsResource`** - -## Methods - -### addCountry - -▸ **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 - -#### Defined in - -[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-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 - -#### Defined in - -[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-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | region id | -| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-8.internal.AdminPostRegionsRegionPaymentProvidersReq.md) | payment 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 payment provider to a region - -#### Defined in - -[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-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostRegionsReq`](internal-8.internal.AdminPostRegionsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> - -created region. - -**`Description`** - -creates a region. - -#### Defined in - -[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-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | id of region to delete. | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> - -Deleted response - -**`Description`** - -deletes a region - -#### Defined in - -[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-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | region id | -| `country_code` | `string` | the 2 character ISO code for the Country. | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`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 - -[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-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | region id | -| `provider_id` | `string` | the if of the fulfillment provider | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> - -updated region - -**`Description`** - -remove a fulfillment provider from a region - -#### Defined in - -[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-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | region id | -| `provider_id` | `string` | the id of the payment provider | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> - -updated region - -**`Description`** - -removes a payment provider from a region - -#### Defined in - -[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-12.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-8.internal.md#adminregionslistres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `query?` | [`AdminGetRegionsParams`](internal-8.internal.AdminGetRegionsParams.md) | query for searching regions | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`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 - -[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-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | id of the region to retrieve. | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> - -the region with the given id - -**`Description`** - -get a region - -#### Defined in - -[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-12.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | region id | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`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 - -[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-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | id of the region to update. | -| `payload` | [`AdminPostRegionsRegionReq`](internal-8.internal.AdminPostRegionsRegionReq.md) | update to apply to region. | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> - -the updated region. - -**`Description`** - -updates a region - -#### Defined in - -[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 deleted file mode 100644 index 7c9fdfb88d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminReservationsResource.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -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 deleted file mode 100644 index b7e3bc80a0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminReturnReasonsResource.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminReturnReasonsResource - -## Hierarchy - -- `default` - - ↳ **`AdminReturnReasonsResource`** - -## Methods - -### create - -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostReturnReasonsReq`](internal-8.internal.AdminPostReturnReasonsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\> - -Created return reason. - -**`Description`** - -Creates a return reason. - -#### Defined in - -[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-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | id of return reason to delete. | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> - -Deleted response - -**`Description`** - -deletes a return reason - -#### Defined in - -[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-12.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-8.internal.md#adminreturnreasonslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`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 - -[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-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`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`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 - -[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-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-8.internal.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\> - -the updated return reason. - -**`Description`** - -Updates a return reason - -#### Defined in - -[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 deleted file mode 100644 index 1a728a1602..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminReturnsResource.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminReturnsResource - -## Hierarchy - -- `default` - - ↳ **`AdminReturnsResource`** - -## Methods - -### cancel - -▸ **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`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`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 - -[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-12.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-8.internal.md#adminreturnslistres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `query?` | [`AdminGetReturnsParams`](internal-8.internal.AdminGetReturnsParams.md) | query for searching returns | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`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 - -[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-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-8.internal.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-8.internal.md#adminreturnsres)\> - -the return - -**`Description`** - -receive a return - -#### Defined in - -[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 deleted file mode 100644 index 7b9bab2e77..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminSalesChannelsResource - -## Hierarchy - -- `default` - - ↳ **`AdminSalesChannelsResource`** - -## Methods - -### addLocation - -▸ **addLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> - -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. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `salesChannelId` | `string` | -| `payload` | [`AdminPostSalesChannelsChannelStockLocationsReq`](internal-8.internal.AdminPostSalesChannelsChannelStockLocationsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> - -the Medusa SalesChannel - -**`Description`** - -Add a stock location to a SalesChannel - -#### Defined in - -[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-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostSalesChannelsReq`](internal-8.internal.AdminPostSalesChannelsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> - -#### Defined in - -[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-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. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `salesChannelId` | `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 sales channel - -#### Defined in - -[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-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 | -| :------ | :------ | -| `salesChannelId` | `string` | -| `payload` | [`AdminDeleteSalesChannelsChannelStockLocationsReq`](internal-8.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> - -an deletion result - -**`Description`** - -Remove a stock location from a SalesChannel - -#### Defined in - -[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-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. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `salesChannelId` | `string` | -| `payload` | [`AdminDeleteSalesChannelsChannelProductsBatchReq`](internal-8.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.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`** - -Remove products from a sales channel - -#### Defined in - -[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-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. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `salesChannelId` | `string` | -| `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`** - -gets a sales channel - -#### Defined in - -[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-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. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `salesChannelId` | `string` | -| `payload` | [`AdminPostSalesChannelsSalesChannelReq`](internal-8.internal.AdminPostSalesChannelsSalesChannelReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`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 - -[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 deleted file mode 100644 index 02d3616afa..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminShippingOptionsResource.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminShippingOptionsResource - -## Hierarchy - -- `default` - - ↳ **`AdminShippingOptionsResource`** - -## Methods - -### create - -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostShippingOptionsReq`](internal-8.internal.AdminPostShippingOptionsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\> - -created shipping option. - -**`Description`** - -creates a shipping option. - -#### Defined in - -[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-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | id of shipping option to delete. | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> - -deleted response - -**`Description`** - -deletes a shipping option - -#### Defined in - -[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-12.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-8.internal.md#adminshippingoptionslistres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `query?` | [`AdminGetShippingOptionsParams`](internal-8.internal.AdminGetShippingOptionsParams.md) | query for searching shipping options | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`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 - -[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-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`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`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 - -[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-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-8.internal.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\> - -the updated shipping option. - -**`Description`** - -updates a shipping option - -#### Defined in - -[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 deleted file mode 100644 index 013afce3a3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminShippingProfilesResource - -## Hierarchy - -- `default` - - ↳ **`AdminShippingProfilesResource`** - -## Methods - -### create - -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostShippingProfilesReq`](internal-8.internal.AdminPostShippingProfilesReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\> - -#### Defined in - -[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-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)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-8.internal.md#adminshippingprofileslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-8.internal.md#adminshippingprofileslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-8.internal.AdminPostShippingProfilesProfileReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\> - -#### Defined in - -[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 deleted file mode 100644 index c658a88d7a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -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 deleted file mode 100644 index c5bc8863bc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminStoresResource.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminStoresResource - -## Hierarchy - -- `default` - - ↳ **`AdminStoresResource`** - -## Methods - -### addCurrency - -▸ **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`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\> - -updated store. - -**`Description`** - -adds a currency to the store. - -#### Defined in - -[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-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`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`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 - -[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-12.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-8.internal.md#adminpaymentproviderslist)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`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 - -[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-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 - -#### Defined in - -[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-12.md#responsepromise)<[`AdminExtendedStoresRes`](../modules/internal-8.internal.md#adminextendedstoresres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminExtendedStoresRes`](../modules/internal-8.internal.md#adminextendedstoresres)\> - -a medusa store - -**`Description`** - -gets a medusa store - -#### Defined in - -[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-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\> - -the updated store. - -**`Description`** - -Updates the store - -#### Defined in - -[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 deleted file mode 100644 index 1e2b066d97..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminSwapsResource.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminSwapsResource - -## Hierarchy - -- `default` - - ↳ **`AdminSwapsResource`** - -## Methods - -### list - -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-8.internal.md#adminswapslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetSwapsParams`](internal-8.internal.AdminGetSwapsParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-8.internal.md#adminswapslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-8.internal.md#adminswapsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-8.internal.md#adminswapsres)\> - -#### Defined in - -[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 deleted file mode 100644 index 084296647a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminTaxRatesResource - -## Hierarchy - -- `default` - - ↳ **`AdminTaxRatesResource`** - -## Methods - -### addProductTypes - -▸ **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-8.internal.AdminPostTaxRatesTaxRateProductTypesReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Defined in - -[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-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)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-8.internal.md#admintaxrateslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetTaxRatesParams`](internal-8.internal.AdminGetTaxRatesParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-8.internal.md#admintaxrateslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `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-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> - -#### Defined in - -[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 deleted file mode 100644 index a26b8ee004..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminUploadsResource.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminUploadsResource - -## Hierarchy - -- `default` - - ↳ **`AdminUploadsResource`** - -## Properties - -### headers - -• `Private` **headers**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `Content-Type` | `string` | - -#### Defined in - -[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 - -### \_createPayload - -▸ `Private` **_createPayload**(`file`): `FormData` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `file` | [`AdminCreateUploadPayload`](../modules/internal-10.md#admincreateuploadpayload) | - -#### Returns - -`FormData` - -#### Defined in - -[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-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 with ACL or a non-public bucket to the specific fileservice that is installed in Medusa. - -#### Defined in - -[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-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminDeleteUploadsReq`](internal-8.internal.AdminDeleteUploadsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> - -#### Defined in - -[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-12.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-8.internal.md#adminuploadsdownloadurlres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-8.internal.AdminPostUploadsDownloadUrlReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-8.internal.md#adminuploadsdownloadurlres)\> - -#### Defined in - -[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 deleted file mode 100644 index d50c493d71..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminUsersResource.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminUsersResource - -## Hierarchy - -- `default` - - ↳ **`AdminUsersResource`** - -## Methods - -### create - -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | [`AdminCreateUserPayload`](../modules/internal-11.md#admincreateuserpayload) | user creation request body | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`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 - -[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-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`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> - -delete response - -**`Description`** - -deletes a user - -#### Defined in - -[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-12.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-8.internal.md#adminuserslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-8.internal.md#adminuserslistres)\> - -a list of all users - -**`Description`** - -lists all users - -#### Defined in - -[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-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | [`AdminResetPasswordRequest`](internal-8.internal.AdminResetPasswordRequest.md) | reset password information. | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> - -**`Description`** - -resets the users password given the correct token. - -#### Defined in - -[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-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> - -Retrieves a given user - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | id of the user | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> - -the user - -#### Defined in - -[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-12.md#responsepromise)<`void`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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-12.md#responsepromise)<`void`\> - -**`Description`** - -resets password by re-sending password token. - -#### Defined in - -[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-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-11.md#adminupdateuserpayload) | user update request body | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> - -the updated user - -**`Description`** - -updates a given user - -#### Defined in - -[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 deleted file mode 100644 index eb2502c2be..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AdminVariantsResource.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminVariantsResource - -## Hierarchy - -- `default` - - ↳ **`AdminVariantsResource`** - -## Methods - -### getInventory - -▸ **getInventory**(`variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../modules/internal-8.internal.md#admingetvariantsvariantinventoryres)\> - -#### Parameters - -| 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-12.md#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../modules/internal-8.internal.md#admingetvariantsvariantinventoryres)\> - -#### Defined in - -[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 deleted file mode 100644 index b21cbf2415..0000000000 --- a/www/apps/docs/content/references/js-client/classes/AuthResource.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AuthResource - -## Hierarchy - -- `default` - - ↳ **`AuthResource`** - -## Methods - -### authenticate - -▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreAuthRes`](../modules/internal-8.internal.md#storeauthres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | [`StorePostAuthReq`](internal-8.internal.StorePostAuthReq.md) | authentication payload | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreAuthRes`](../modules/internal-8.internal.md#storeauthres)\> - -**`Description`** - -Authenticates a customer using email and password combination - -#### Defined in - -[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-12.md#responsepromise)<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\> - -**`Description`** - -Removes authentication session - -#### Defined in - -[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-12.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-8.internal.md#storegetauthemailres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `email` | `string` | is required | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-8.internal.md#storegetauthemailres)\> - -**`Description`** - -Check if email exists - -#### Defined in - -[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-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 | -| :------ | :------ | -| `payload` | [`StorePostAuthReq`](internal-8.internal.StorePostAuthReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreBearerAuthRes`](../modules/internal-8.internal.md#storebearerauthres)\> - -**`Description`** - -Retrieves a new JWT access token - -#### Defined in - -[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 deleted file mode 100644 index e3eca47876..0000000000 --- a/www/apps/docs/content/references/js-client/classes/CartsResource.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: CartsResource - -## Hierarchy - -- `default` - - ↳ **`CartsResource`** - -## Properties - -### lineItems - -• **lineItems**: [`LineItemsResource`](LineItemsResource.md) - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -Adds a shipping method to cart - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | Id of cart | -| `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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -#### Defined in - -[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-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 provided, we will generate one for the request. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | is required | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-8.internal.md#storecompletecartres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -Creates a cart - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -#### Defined in - -[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-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. -This is usually called when a customer proceeds to checkout. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | is required | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -Removes a discount from cart. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | is required | -| `code` | `string` | discount code to remove | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -#### Defined in - -[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-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 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | is required | -| `provider_id` | `string` | the provider id of the session e.g. "stripe" | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -Refreshes a payment session. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | is required | -| `provider_id` | `string` | the provider id of the session e.g. "stripe" | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -Retrieves a cart - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | is required | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -Refreshes a payment session. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | is required | -| `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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -Updates a cart - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | is required | -| `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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -Updates the payment method - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | is required | -| `provider_id` | `string` | is required | -| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal-8.internal.StorePostCartsCartPaymentSessionUpdateReq.md) | is required | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -#### Defined in - -[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 deleted file mode 100644 index 12697f9ef7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/CollectionsResource.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: CollectionsResource - -## Hierarchy - -- `default` - - ↳ **`CollectionsResource`** - -## Methods - -### list - -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-8.internal.md#storecollectionslistres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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-12.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-8.internal.md#storecollectionslistres)\> - -**`Description`** - -Retrieves a list of collections - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-8.internal.md#storecollectionsres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | id of the collection | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-8.internal.md#storecollectionsres)\> - -**`Description`** - -Retrieves a single collection - -#### Defined in - -[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 deleted file mode 100644 index b3bb813c85..0000000000 --- a/www/apps/docs/content/references/js-client/classes/CustomerResource.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: CustomerResource - -## Hierarchy - -- `default` - - ↳ **`CustomerResource`** - -## Properties - -### addresses - -• **addresses**: [`AddressesResource`](AddressesResource.md) - -#### Defined in - -[packages/medusa-js/src/resources/customers.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L18) - -___ - -### paymentMethods - -• **paymentMethods**: [`PaymentMethodsResource`](PaymentMethodsResource.md) - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -Creates a customer - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | [`StorePostCustomersReq`](internal-8.internal.StorePostCustomersReq.md) | information of customer | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -#### Defined in - -[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-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. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal-8.internal.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise) - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-8.internal.md#storecustomerslistordersres)\> - -Retrieve customer orders - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal-8.internal.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-8.internal.md#storecustomerslistordersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -Resets customer password - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -Retrieves the customer that is currently logged - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -Updates a customer - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | [`StorePostCustomersCustomerReq`](internal-8.internal.StorePostCustomersCustomerReq.md) | information to update customer with | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> - -#### Defined in - -[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 deleted file mode 100644 index ef025cbbae..0000000000 --- a/www/apps/docs/content/references/js-client/classes/GiftCardsResource.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: GiftCardsResource - -## Hierarchy - -- `default` - - ↳ **`GiftCardsResource`** - -## Methods - -### retrieve - -▸ **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`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-8.internal.md#storegiftcardsres)\> - -**`Description`** - -Retrieves a single GiftCard - -#### Defined in - -[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 deleted file mode 100644 index d3a7be1564..0000000000 --- a/www/apps/docs/content/references/js-client/classes/LineItemsResource.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: LineItemsResource - -## Hierarchy - -- `default` - - ↳ **`LineItemsResource`** - -## Methods - -### create - -▸ **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 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | id of cart | -| `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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -Remove a line-item from a cart - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | id of cart | -| `line_id` | `string` | id of item to remove | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -Updates a line-item. -Only quantity updates are allowed - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | id of cart | -| `line_id` | `string` | id of item to update | -| `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-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> - -#### Defined in - -[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 deleted file mode 100644 index f897747cb8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/OrderEditsResource.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: OrderEditsResource - -## Hierarchy - -- `default` - - ↳ **`OrderEditsResource`** - -## Methods - -### complete - -▸ **complete**(`id`, `customHeaders?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[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) - -___ - -### decline - -▸ **decline**(`id`, `payload`, `customHeaders?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`StorePostOrderEditsOrderEditDecline`](internal-8.internal.StorePostOrderEditsOrderEditDecline.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-8.internal.md#storeordereditsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-8.internal.md#storeordereditsres)\> - -#### Defined in - -[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 deleted file mode 100644 index 5bb2fa1490..0000000000 --- a/www/apps/docs/content/references/js-client/classes/OrdersResource.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: OrdersResource - -## Hierarchy - -- `default` - - ↳ **`OrdersResource`** - -## Methods - -### confirmRequest - -▸ **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 - -#### Defined in - -[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-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 - -#### Defined in - -[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-12.md#responsepromise) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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-12.md#responsepromise) - -**`Description`** - -Request access to a list of orders - -#### Defined in - -[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-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | is required | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\> - -**`Description`** - -Retrieves an order - -#### Defined in - -[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-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | is required | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\> - -**`Description`** - -Retrieves an order by cart id - -#### Defined in - -[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 deleted file mode 100644 index 08f2373787..0000000000 --- a/www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: PaymentCollectionsResource - -## Hierarchy - -- `default` - - ↳ **`PaymentCollectionsResource`** - -## Methods - -### authorizePaymentSession - -▸ **authorizePaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `session_id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`StorePostPaymentCollectionsBatchSessionsAuthorizeReq`](internal-8.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`StorePaymentCollectionSessionsReq`](internal-8.internal.StorePaymentCollectionSessionsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`StorePostPaymentCollectionsBatchSessionsReq`](internal-8.internal.StorePostPaymentCollectionsBatchSessionsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StorePaymentCollectionsSessionRes`](../modules/internal-8.internal.md#storepaymentcollectionssessionres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `session_id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsSessionRes`](../modules/internal-8.internal.md#storepaymentcollectionssessionres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `query?` | [`StoreGetPaymentCollectionsParams`](internal-8.internal.StoreGetPaymentCollectionsParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> - -#### Defined in - -[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 deleted file mode 100644 index 52fddb50fa..0000000000 --- a/www/apps/docs/content/references/js-client/classes/PaymentMethodsResource.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: PaymentMethodsResource - -## Hierarchy - -- `default` - - ↳ **`PaymentMethodsResource`** - -## Methods - -### list - -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-8.internal.md#storecustomerslistpaymentmethodsres)\> - -Lists customer payment methods - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-8.internal.md#storecustomerslistpaymentmethodsres)\> - -#### Defined in - -[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 deleted file mode 100644 index 0adee3adc5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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 deleted file mode 100644 index b5698b7ff8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/ProductTagsResource.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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 deleted file mode 100644 index c32768ea11..0000000000 --- a/www/apps/docs/content/references/js-client/classes/ProductTypesResource.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductTypesResource - -## Hierarchy - -- `default` - - ↳ **`ProductTypesResource`** - -## Methods - -### list - -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-8.internal.md#storeproducttypeslistres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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-12.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-8.internal.md#storeproducttypeslistres)\> - -**`Description`** - -Retrieves a list of product types - -#### Defined in - -[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 deleted file mode 100644 index 92df80056f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/ProductVariantsResource.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductVariantsResource - -## Hierarchy - -- `default` - - ↳ **`ProductVariantsResource`** - -## Methods - -### list - -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-8.internal.md#storevariantslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`StoreGetVariantsParams`](internal-8.internal.StoreGetVariantsParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-8.internal.md#storevariantslistres)\> - -**`Description`** - -Retrieves a list of of Product Variants - -#### Defined in - -[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-12.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-8.internal.md#storevariantsres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | is required | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-8.internal.md#storevariantsres)\> - -**`Description`** - -Retrieves a single product variant - -#### Defined in - -[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 deleted file mode 100644 index b0752f4cc9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/ProductsResource.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductsResource - -## Hierarchy - -- `default` - - ↳ **`ProductsResource`** - -## Properties - -### variants - -• **variants**: [`ProductVariantsResource`](ProductVariantsResource.md) - -#### Defined in - -[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-12.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-8.internal.md#storeproductslistres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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-12.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-8.internal.md#storeproductslistres)\> - -**`Description`** - -Retrieves a list of products - -#### Defined in - -[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-12.md#responsepromise)<[`StoreProductsRes`](../modules/internal-8.internal.md#storeproductsres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | is required | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductsRes`](../modules/internal-8.internal.md#storeproductsres)\> - -**`Description`** - -Retrieves a single Product - -#### Defined in - -[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-12.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-8.internal.md#storepostsearchres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `searchOptions` | [`StorePostSearchReq`](internal-8.internal.StorePostSearchReq.md) | is required | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-8.internal.md#storepostsearchres)\> - -**`Description`** - -Searches for products - -#### Defined in - -[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 deleted file mode 100644 index 2bbd41178c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/RegionsResource.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: RegionsResource - -## Hierarchy - -- `default` - - ↳ **`RegionsResource`** - -## Methods - -### list - -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-8.internal.md#storeregionslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-8.internal.md#storeregionslistres)\> - -**`Description`** - -Retrieves a list of regions - -#### Defined in - -[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-12.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-8.internal.md#storeregionsres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | is required | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-8.internal.md#storeregionsres)\> - -**`Description`** - -Retrieves a region - -#### Defined in - -[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 deleted file mode 100644 index ac04755ac9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/ReturnReasonsResource.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ReturnReasonsResource - -## Hierarchy - -- `default` - - ↳ **`ReturnReasonsResource`** - -## Methods - -### list - -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-8.internal.md#storereturnreasonslistres)\> - -Lists return reasons defined in Medusa Admin - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-8.internal.md#storereturnreasonslistres)\> - -#### Defined in - -[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-12.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-8.internal.md#storereturnreasonsres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | is required | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-8.internal.md#storereturnreasonsres)\> - -**`Description`** - -Retrieves a single Return Reason - -#### Defined in - -[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 deleted file mode 100644 index 03724bf3ae..0000000000 --- a/www/apps/docs/content/references/js-client/classes/ReturnsResource.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ReturnsResource - -## Hierarchy - -- `default` - - ↳ **`ReturnsResource`** - -## Methods - -### create - -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-8.internal.md#storereturnsres)\> - -Creates a return request - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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-12.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-8.internal.md#storereturnsres)\> - -#### Defined in - -[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 deleted file mode 100644 index 68071ca9ac..0000000000 --- a/www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ShippingOptionsResource - -## Hierarchy - -- `default` - - ↳ **`ShippingOptionsResource`** - -## Methods - -### list - -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`StoreGetShippingOptionsParams`](internal-8.internal.StoreGetShippingOptionsParams.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\> - -**`Description`** - -Lists shipping options available - -#### Defined in - -[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-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cart_id` | `string` | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\> - -**`Description`** - -Lists shipping options available for a cart - -#### Defined in - -[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 deleted file mode 100644 index 5072c642f6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/SwapsResource.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: SwapsResource - -## Hierarchy - -- `default` - - ↳ **`SwapsResource`** - -## Methods - -### create - -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`StorePostSwapsReq`](internal-8.internal.StorePostSwapsReq.md) | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\> - -**`Description`** - -Creates a swap from a cart - -#### Defined in - -[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-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cart_id` | `string` | id of cart | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\> - -**`Description`** - -Retrieves a swap by cart id - -#### Defined in - -[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 deleted file mode 100644 index 26a7db6e0e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -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 - -• **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/auth/create-session.d.ts:78 - -___ - -### password - -• **password**: `string` - -#### Defined in - -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 deleted file mode 100644 index da80bb34f4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-1.BaseEntity.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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 deleted file mode 100644 index f2b17568f5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-1.SoftDeletableEntity.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -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 deleted file mode 100644 index 56f6028958..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-1.User.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: User - -[internal](../modules/internal-1.md).User - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) - - ↳ **`User`** - -## Properties - -### api\_token - -• **api\_token**: `string` - -#### Defined in - -packages/medusa/dist/models/user.d.ts:13 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -packages/medusa/dist/models/user.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 - -___ - -### email - -• **email**: `string` - -#### Defined in - -packages/medusa/dist/models/user.d.ts:9 - -___ - -### first\_name - -• **first\_name**: `string` - -#### Defined in - -packages/medusa/dist/models/user.d.ts:10 - -___ - -### 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/user.d.ts:11 - -___ - -### metadata - -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Defined in - -packages/medusa/dist/models/user.d.ts:14 - -___ - -### password\_hash - -• **password\_hash**: `string` - -#### Defined in - -packages/medusa/dist/models/user.d.ts:12 - -___ - -### role - -• **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) - -#### Defined in - -packages/medusa/dist/models/user.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-12.Axios.md b/www/apps/docs/content/references/js-client/classes/internal-12.Axios.md deleted file mode 100644 index 0706a570e4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-12.Axios.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Axios - -[internal](../modules/internal-12.md).Axios - -## Hierarchy - -- **`Axios`** - - ↳ [`AxiosInstance`](../interfaces/internal-12.AxiosInstance.md) - -## Properties - -### defaults - -• **defaults**: [`AxiosDefaults`](../interfaces/internal-12.AxiosDefaults.md)<`any`\> - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:171 - -___ - -### interceptors - -• **interceptors**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `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 - -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`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | `AxiosRequestConfig`<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### 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`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | `AxiosRequestConfig`<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:178 - -___ - -### getUri - -▸ **getUri**(`config?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config?` | `AxiosRequestConfig`<`any`\> | - -#### Returns - -`string` - -#### 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`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | `AxiosRequestConfig`<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### 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`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | `AxiosRequestConfig`<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### 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`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | `AxiosRequestConfig`<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### 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`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | `AxiosRequestConfig`<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### 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`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | `AxiosRequestConfig`<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### 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`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `AxiosRequestConfig`<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Defined in - -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 deleted file mode 100644 index 3ba34504e6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-12.Client.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -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-2.AdminGetBatchPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-2.AdminGetBatchPaginationParams.md deleted file mode 100644 index 2cb4c3865d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-2.AdminGetBatchPaginationParams.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetBatchPaginationParams - -[internal](../modules/internal-2.md).AdminGetBatchPaginationParams - -## Hierarchy - -- **`AdminGetBatchPaginationParams`** - - ↳ [`AdminGetBatchParams`](internal-2.AdminGetBatchParams.md) - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:255 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:256 - -___ - -### limit - -• **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:253 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:254 - -___ - -### order - -• `Optional` **order**: `string` - -#### Defined in - -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 deleted file mode 100644 index abe35958ed..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-2.AdminGetBatchParams.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetBatchParams - -[internal](../modules/internal-2.md).AdminGetBatchParams - -## Hierarchy - -- [`AdminGetBatchPaginationParams`](internal-2.AdminGetBatchPaginationParams.md) - - ↳ **`AdminGetBatchParams`** - -## Properties - -### canceled\_at - -• `Optional` **canceled\_at**: ``null`` \| [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:266 - -___ - -### completed\_at - -• `Optional` **completed\_at**: ``null`` \| [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:264 - -___ - -### confirmed\_at - -• `Optional` **confirmed\_at**: ``null`` \| [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:262 - -___ - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:267 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -[AdminGetBatchPaginationParams](internal-2.AdminGetBatchPaginationParams.md).[expand](internal-2.AdminGetBatchPaginationParams.md#expand) - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:255 - -___ - -### failed\_at - -• `Optional` **failed\_at**: ``null`` \| [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:265 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -[AdminGetBatchPaginationParams](internal-2.AdminGetBatchPaginationParams.md).[fields](internal-2.AdminGetBatchPaginationParams.md#fields) - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:256 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:260 - -___ - -### limit - -• **limit**: `number` - -#### Inherited from - -[AdminGetBatchPaginationParams](internal-2.AdminGetBatchPaginationParams.md).[limit](internal-2.AdminGetBatchPaginationParams.md#limit) - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:253 - -___ - -### offset - -• **offset**: `number` - -#### Inherited from - -[AdminGetBatchPaginationParams](internal-2.AdminGetBatchPaginationParams.md).[offset](internal-2.AdminGetBatchPaginationParams.md#offset) - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:254 - -___ - -### order - -• `Optional` **order**: `string` - -#### Inherited from - -[AdminGetBatchPaginationParams](internal-2.AdminGetBatchPaginationParams.md).[order](internal-2.AdminGetBatchPaginationParams.md#order) - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:257 - -___ - -### pre\_processed\_at - -• `Optional` **pre\_processed\_at**: ``null`` \| [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:263 - -___ - -### type - -• `Optional` **type**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:261 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -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.BatchJob.md b/www/apps/docs/content/references/js-client/classes/internal-2.BatchJob.md deleted file mode 100644 index 8a80cf7094..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-2.BatchJob.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: BatchJob - -[internal](../modules/internal-2.md).BatchJob - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) - - ↳ **`BatchJob`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -packages/medusa/dist/models/batch-job.d.ts:27 - -___ - -### canceled\_at - -• `Optional` **canceled\_at**: `Date` - -#### Defined in - -packages/medusa/dist/models/batch-job.d.ts:23 - -___ - -### completed\_at - -• `Optional` **completed\_at**: `Date` - -#### Defined in - -packages/medusa/dist/models/batch-job.d.ts:22 - -___ - -### confirmed\_at - -• `Optional` **confirmed\_at**: `Date` - -#### Defined in - -packages/medusa/dist/models/batch-job.d.ts:21 - -___ - -### context - -• **context**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Defined in - -packages/medusa/dist/models/batch-job.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 - -___ - -### created\_by - -• **created\_by**: ``null`` \| `string` - -#### Defined in - -packages/medusa/dist/models/batch-job.d.ts:6 - -___ - -### created\_by\_user - -• **created\_by\_user**: [`User`](internal-1.User.md) - -#### Defined in - -packages/medusa/dist/models/batch-job.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 - -___ - -### dry\_run - -• **dry\_run**: `boolean` - -#### Defined in - -packages/medusa/dist/models/batch-job.d.ts:18 - -___ - -### failed\_at - -• `Optional` **failed\_at**: `Date` - -#### Defined in - -packages/medusa/dist/models/batch-job.d.ts:24 - -___ - -### 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 - -___ - -### pre\_processed\_at - -• `Optional` **pre\_processed\_at**: `Date` - -#### Defined in - -packages/medusa/dist/models/batch-job.d.ts:19 - -___ - -### processing\_at - -• `Optional` **processing\_at**: `Date` - -#### Defined in - -packages/medusa/dist/models/batch-job.d.ts:20 - -___ - -### result - -• **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 - -packages/medusa/dist/models/batch-job.d.ts:9 - -___ - -### status - -• **status**: [`BatchJobStatus`](../enums/internal-2.BatchJobStatus.md) - -#### Defined in - -packages/medusa/dist/models/batch-job.d.ts:25 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/medusa/dist/models/batch-job.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 - -## Methods - -### loadStatus - -▸ **loadStatus**(): `void` - -#### Returns - -`void` - -#### Defined in - -packages/medusa/dist/models/batch-job.d.ts:26 - -___ - -### toJSON - -▸ **toJSON**(): [`BatchJob`](internal-2.BatchJob.md) - -#### Returns - -[`BatchJob`](internal-2.BatchJob.md) - -#### Defined in - -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 deleted file mode 100644 index 5732b5db69..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-2.DateComparisonOperator.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: DateComparisonOperator - -[internal](../modules/internal-2.md).DateComparisonOperator - -## Properties - -### gt - -• `Optional` **gt**: `Date` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:84 - -___ - -### gte - -• `Optional` **gte**: `Date` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:85 - -___ - -### lt - -• `Optional` **lt**: `Date` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:83 - -___ - -### lte - -• `Optional` **lte**: `Date` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:86 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 deleted file mode 100644 index 0ead406ef4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Address.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -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 deleted file mode 100644 index 019c8c8030..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.AdminDeleteProductsFromCollectionReq.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -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 - -• **product\_ids**: `string`[] - -#### Defined in - -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 deleted file mode 100644 index ba079c4347..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsPaginationParams.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetCollectionsPaginationParams - -[internal](../modules/internal-3.md).AdminGetCollectionsPaginationParams - -## Hierarchy - -- **`AdminGetCollectionsPaginationParams`** - - ↳ [`AdminGetCollectionsParams`](internal-3.AdminGetCollectionsParams.md) - -## Properties - -### limit - -• **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:130 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -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 deleted file mode 100644 index d3433d0695..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsParams.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetCollectionsParams - -[internal](../modules/internal-3.md).AdminGetCollectionsParams - -## Hierarchy - -- [`AdminGetCollectionsPaginationParams`](internal-3.AdminGetCollectionsPaginationParams.md) - - ↳ **`AdminGetCollectionsParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:136 - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:138 - -___ - -### discount\_condition\_id - -• `Optional` **discount\_condition\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:140 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:135 - -___ - -### limit - -• **limit**: `number` - -#### Inherited from - -[AdminGetCollectionsPaginationParams](internal-3.AdminGetCollectionsPaginationParams.md).[limit](internal-3.AdminGetCollectionsPaginationParams.md#limit) - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:130 - -___ - -### offset - -• **offset**: `number` - -#### Inherited from - -[AdminGetCollectionsPaginationParams](internal-3.AdminGetCollectionsPaginationParams.md).[offset](internal-3.AdminGetCollectionsPaginationParams.md#offset) - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:131 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:139 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:134 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -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 deleted file mode 100644 index 3b775fedf5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsCollectionReq.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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 - -• `Optional` **handle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:86 - -___ - -### metadata - -• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:87 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -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 deleted file mode 100644 index 8caa9ca4e9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsReq.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 - -• `Optional` **handle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:86 - -___ - -### metadata - -• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:87 - -___ - -### title - -• **title**: `string` - -#### Defined in - -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 deleted file mode 100644 index b1702423a8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostProductsToCollectionReq.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -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 - -• **product\_ids**: `string`[] - -#### Defined in - -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 deleted file mode 100644 index 808cde92ca..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Cart.md +++ /dev/null @@ -1,471 +0,0 @@ ---- -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 deleted file mode 100644 index 48f8f0b929..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ClaimImage.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -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 deleted file mode 100644 index b5e750f264..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ClaimItem.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -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 deleted file mode 100644 index 3790d40333..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ClaimOrder.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -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 deleted file mode 100644 index 767245a2b5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ClaimTag.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -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-3.Country.md b/www/apps/docs/content/references/js-client/classes/internal-3.Country.md deleted file mode 100644 index a76c651dd1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Country.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Country - -[internal](../modules/internal-3.md).Country - -## Properties - -### display\_name - -• **display\_name**: `string` - -#### Defined in - -packages/medusa/dist/models/country.d.ts:8 - -___ - -### id - -• **id**: `number` - -#### Defined in - -packages/medusa/dist/models/country.d.ts:3 - -___ - -### iso\_2 - -• **iso\_2**: `string` - -#### Defined in - -packages/medusa/dist/models/country.d.ts:4 - -___ - -### iso\_3 - -• **iso\_3**: `string` - -#### Defined in - -packages/medusa/dist/models/country.d.ts:5 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/medusa/dist/models/country.d.ts:7 - -___ - -### num\_code - -• **num\_code**: `number` - -#### Defined in - -packages/medusa/dist/models/country.d.ts:6 - -___ - -### region - -• **region**: [`Region`](internal-3.Region.md) - -#### Defined in - -packages/medusa/dist/models/country.d.ts:10 - -___ - -### region\_id - -• **region\_id**: ``null`` \| `string` - -#### Defined in - -packages/medusa/dist/models/country.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Currency.md b/www/apps/docs/content/references/js-client/classes/internal-3.Currency.md deleted file mode 100644 index fe90cc4181..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Currency.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Currency - -[internal](../modules/internal-3.md).Currency - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -packages/medusa/dist/models/currency.d.ts:2 - -___ - -### includes\_tax - -• `Optional` **includes\_tax**: `boolean` - -#### Defined in - -packages/medusa/dist/models/currency.d.ts:6 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/medusa/dist/models/currency.d.ts:5 - -___ - -### symbol - -• **symbol**: `string` - -#### Defined in - -packages/medusa/dist/models/currency.d.ts:3 - -___ - -### symbol\_native - -• **symbol\_native**: `string` - -#### Defined in - -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 deleted file mode 100644 index 5ffef72c6b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Customer.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -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 deleted file mode 100644 index 77bdf2afb6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.CustomerGroup.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -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 deleted file mode 100644 index c5d55817e1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Discount.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -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 deleted file mode 100644 index f45d358370..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.DiscountCondition.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -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 deleted file mode 100644 index 4c3c9298d1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.DiscountRule.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -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 deleted file mode 100644 index 6f5400b7a9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.DraftOrder.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -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 deleted file mode 100644 index 8d19ebd8a1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Fulfillment.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -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 deleted file mode 100644 index c9960dfe4b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.FulfillmentItem.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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-3.FulfillmentProvider.md b/www/apps/docs/content/references/js-client/classes/internal-3.FulfillmentProvider.md deleted file mode 100644 index 72156f8227..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.FulfillmentProvider.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: FulfillmentProvider - -[internal](../modules/internal-3.md).FulfillmentProvider - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/medusa/dist/models/fulfillment-provider.d.ts:2 - -___ - -### is\_installed - -• **is\_installed**: `boolean` - -#### Defined in - -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 deleted file mode 100644 index b4e6736498..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.GiftCard.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -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 deleted file mode 100644 index dc295cdcd8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.GiftCardTransaction.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -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 deleted file mode 100644 index 17e3e4f980..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Image.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -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 deleted file mode 100644 index c59c01d4dc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.LineItem.md +++ /dev/null @@ -1,495 +0,0 @@ ---- -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 deleted file mode 100644 index dded692bd3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.LineItemAdjustment.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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 deleted file mode 100644 index 4b01f456a0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.LineItemTaxLine.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -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 deleted file mode 100644 index 745661ada5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.MoneyAmount.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -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 deleted file mode 100644 index b5705afb6f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Order.md +++ /dev/null @@ -1,587 +0,0 @@ ---- -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-3.OrderEdit.md b/www/apps/docs/content/references/js-client/classes/internal-3.OrderEdit.md deleted file mode 100644 index 80ec2e7b12..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.OrderEdit.md +++ /dev/null @@ -1,341 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: OrderEdit - -[internal](../modules/internal-3.md).OrderEdit - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal-1.BaseEntity.md) - - ↳ **`OrderEdit`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:37 - -___ - -### canceled\_at - -• `Optional` **canceled\_at**: `Date` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:24 - -___ - -### canceled\_by - -• `Optional` **canceled\_by**: `string` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:23 - -___ - -### changes - -• **changes**: [`OrderItemChange`](internal-3.OrderItemChange.md)[] - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:13 - -___ - -### confirmed\_at - -• `Optional` **confirmed\_at**: `Date` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:19 - -___ - -### confirmed\_by - -• `Optional` **confirmed\_by**: `string` - -#### Defined in - -packages/medusa/dist/models/order-edit.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 - -___ - -### created\_by - -• **created\_by**: `string` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:15 - -___ - -### declined\_at - -• `Optional` **declined\_at**: `Date` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:22 - -___ - -### declined\_by - -• `Optional` **declined\_by**: `string` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:20 - -___ - -### declined\_reason - -• `Optional` **declined\_reason**: `string` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:21 - -___ - -### difference\_due - -• **difference\_due**: `number` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:35 - -___ - -### discount\_total - -• **discount\_total**: `number` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:29 - -___ - -### gift\_card\_tax\_total - -• **gift\_card\_tax\_total**: `number` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:34 - -___ - -### gift\_card\_total - -• **gift\_card\_total**: `number` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:33 - -___ - -### 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 - -___ - -### internal\_note - -• `Optional` **internal\_note**: `string` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:14 - -___ - -### items - -• **items**: [`LineItem`](internal-3.LineItem.md)[] - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:25 - -___ - -### order - -• **order**: [`Order`](internal-3.Order.md) - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:12 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:11 - -___ - -### payment\_collection - -• **payment\_collection**: [`PaymentCollection`](internal-3.PaymentCollection.md) - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:27 - -___ - -### payment\_collection\_id - -• **payment\_collection\_id**: `string` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:26 - -___ - -### requested\_at - -• `Optional` **requested\_at**: `Date` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:17 - -___ - -### requested\_by - -• `Optional` **requested\_by**: `string` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:16 - -___ - -### shipping\_total - -• **shipping\_total**: `number` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:28 - -___ - -### status - -• **status**: [`OrderEditStatus`](../enums/internal-3.OrderEditStatus.md) - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:36 - -___ - -### subtotal - -• **subtotal**: `number` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:32 - -___ - -### tax\_total - -• **tax\_total**: ``null`` \| `number` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:30 - -___ - -### total - -• **total**: `number` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:31 - -___ - -### 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 - -## Methods - -### loadStatus - -▸ **loadStatus**(): `void` - -#### Returns - -`void` - -#### Defined in - -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 deleted file mode 100644 index e0caf2d05a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.OrderItemChange.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -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 deleted file mode 100644 index 29837fc7e1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Payment.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -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 deleted file mode 100644 index 73f4fb6243..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.PaymentCollection.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -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-3.PaymentProvider.md b/www/apps/docs/content/references/js-client/classes/internal-3.PaymentProvider.md deleted file mode 100644 index 2aa0bcebda..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.PaymentProvider.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: PaymentProvider - -[internal](../modules/internal-3.md).PaymentProvider - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/medusa/dist/models/payment-provider.d.ts:2 - -___ - -### is\_installed - -• **is\_installed**: `boolean` - -#### Defined in - -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 deleted file mode 100644 index 595db711d0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.PaymentSession.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -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 deleted file mode 100644 index e91441a555..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.PriceList.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -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 deleted file mode 100644 index 74e67f05af..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Product.md +++ /dev/null @@ -1,411 +0,0 @@ ---- -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 deleted file mode 100644 index 9a2466981e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ProductCategory.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -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 deleted file mode 100644 index 7a661ec916..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ProductCollection.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -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 deleted file mode 100644 index 807ccebcf1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ProductOption.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -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 deleted file mode 100644 index 6749e6af69..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ProductOptionValue.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -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 deleted file mode 100644 index 494fed2cb5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ProductTag.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -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 deleted file mode 100644 index 79587e9ef9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ProductType.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -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 deleted file mode 100644 index 709522f50e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ProductVariant.md +++ /dev/null @@ -1,321 +0,0 @@ ---- -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 deleted file mode 100644 index 5f99661a6d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ProductVariantInventoryItem.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -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 deleted file mode 100644 index 09dad5217e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Refund.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -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 deleted file mode 100644 index 7c97c3d3ed..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Region.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -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 deleted file mode 100644 index 6362cb65ff..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Return.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -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 deleted file mode 100644 index 55d9d94b51..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ReturnItem.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -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 deleted file mode 100644 index e49c6f5565..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ReturnReason.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -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 deleted file mode 100644 index 9bfaaf395e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.SalesChannel.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -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 deleted file mode 100644 index 9f81b46b23..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.SalesChannelLocation.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -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 deleted file mode 100644 index cfd79d02c4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ShippingMethod.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -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 deleted file mode 100644 index 7aa2bf415c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ShippingMethodTaxLine.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -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 deleted file mode 100644 index f32c764fec..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ShippingOption.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -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 deleted file mode 100644 index 5b0ad9a408..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ShippingOptionRequirement.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index 33c3b45d25..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.ShippingProfile.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -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 deleted file mode 100644 index fc21b640b8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.Swap.md +++ /dev/null @@ -1,281 +0,0 @@ ---- -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 deleted file mode 100644 index be1ea55197..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.TaxLine.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -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-3.TaxProvider.md b/www/apps/docs/content/references/js-client/classes/internal-3.TaxProvider.md deleted file mode 100644 index e5106c474f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.TaxProvider.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: TaxProvider - -[internal](../modules/internal-3.md).TaxProvider - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/medusa/dist/models/tax-provider.d.ts:2 - -___ - -### is\_installed - -• **is\_installed**: `boolean` - -#### Defined in - -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 deleted file mode 100644 index 53c4642e1b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.TaxRate.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -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 deleted file mode 100644 index 5b69e0c3e9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-3.TrackingLink.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -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-4.AdminGetCurrenciesParams.md b/www/apps/docs/content/references/js-client/classes/internal-4.AdminGetCurrenciesParams.md deleted file mode 100644 index 4955676dfc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-4.AdminGetCurrenciesParams.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetCurrenciesParams - -[internal](../modules/internal-4.md).AdminGetCurrenciesParams - -## Hierarchy - -- [`FindPaginationParams`](internal-4.FindPaginationParams.md) - - ↳ **`AdminGetCurrenciesParams`** - -## Properties - -### code - -• `Optional` **code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/currencies/list-currencies.d.ts:57 - -___ - -### includes\_tax - -• `Optional` **includes\_tax**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/currencies/list-currencies.d.ts:58 - -___ - -### 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/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 deleted file mode 100644 index c46cdc1b7b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-4.AdminPostCurrenciesCurrencyReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 - -• `Optional` **includes\_tax**: `boolean` - -#### Defined in - -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 deleted file mode 100644 index 9152bf8a75..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-4.FindPaginationParams.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: FindPaginationParams - -[internal](../modules/internal-4.md).FindPaginationParams - -## Hierarchy - -- **`FindPaginationParams`** - - ↳ [`AdminGetCurrenciesParams`](internal-4.AdminGetCurrenciesParams.md) - - ↳ [`AdminGetProductTypesParams`](internal-8.internal.AdminGetProductTypesParams.md) - - ↳ [`StoreGetProductTagsParams`](internal-8.internal.StoreGetProductTagsParams.md) - - ↳ [`StoreGetProductTypesParams`](internal-8.internal.StoreGetProductTypesParams.md) - -## Properties - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:244 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:243 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 deleted file mode 100644 index 88f507f91e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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 deleted file mode 100644 index 38aa3b84c3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-6.AdminGetCustomerGroupsGroupParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 6d2a276e8c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-6.AdminGetCustomerGroupsParams.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -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 deleted file mode 100644 index 512f478a88..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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 deleted file mode 100644 index 6ff9148062..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsGroupReq.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -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 deleted file mode 100644 index 913bbfdc70..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsReq.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -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.CustomerGroupsBatchCustomer.md b/www/apps/docs/content/references/js-client/classes/internal-6.CustomerGroupsBatchCustomer.md deleted file mode 100644 index 9d414f199d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-6.CustomerGroupsBatchCustomer.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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-6.FilterableCustomerGroupProps.md b/www/apps/docs/content/references/js-client/classes/internal-6.FilterableCustomerGroupProps.md deleted file mode 100644 index efb19f9243..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-6.FilterableCustomerGroupProps.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: FilterableCustomerGroupProps - -[internal](../modules/internal-6.md).FilterableCustomerGroupProps - -## Hierarchy - -- **`FilterableCustomerGroupProps`** - - ↳ [`AdminGetCustomerGroupsParams`](internal-6.AdminGetCustomerGroupsParams.md) - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:7 - -___ - -### discount\_condition\_id - -• `Optional` **discount\_condition\_id**: `string` - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:8 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:3 - -___ - -### name - -• `Optional` **name**: `string`[] - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:5 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:4 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -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 deleted file mode 100644 index 1469979a49..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-6.FindParams.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -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.StringComparisonOperator.md b/www/apps/docs/content/references/js-client/classes/internal-6.StringComparisonOperator.md deleted file mode 100644 index 7427b2d689..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-6.StringComparisonOperator.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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.AdminGetCustomersParams.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminGetCustomersParams.md deleted file mode 100644 index e949aaee8d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminGetCustomersParams.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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.AdminListCustomerSelector.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminListCustomerSelector.md deleted file mode 100644 index 2c734e277a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminListCustomerSelector.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 7b511d9b1d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostCustomersCustomerReq.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -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 deleted file mode 100644 index ff6b6d55cd..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostCustomersReq.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -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.Group.md b/www/apps/docs/content/references/js-client/classes/internal-7.Group.md deleted file mode 100644 index 5e834d154a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.Group.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index 16f0b6ba94..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AbstractEventBusModuleService.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -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 deleted file mode 100644 index 70da797654..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AbstractSearchService.md +++ /dev/null @@ -1,288 +0,0 @@ ---- -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 deleted file mode 100644 index fef3f92204..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem-1.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index d15e4c174c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem-2.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 89ff18af9d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index cf85f1030a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminCreateCondition.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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 deleted file mode 100644 index 9ad1e335cf..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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-8.AdminGetDiscountsDiscountConditionsConditionParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md deleted file mode 100644 index 1a86c409e9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetDiscountsDiscountConditionsConditionParams - -[internal](../modules/internal-8.md).AdminGetDiscountsDiscountConditionsConditionParams - -## Hierarchy - -- [`FindParams`](internal-6.FindParams.md) - - ↳ **`AdminGetDiscountsDiscountConditionsConditionParams`** - -## 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.AdminGetDiscountsDiscountRuleParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsDiscountRuleParams.md deleted file mode 100644 index 2d21ebf711..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsDiscountRuleParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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-8.AdminGetDiscountsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsParams.md deleted file mode 100644 index 2d091b194c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsParams.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetDiscountsParams - -[internal](../modules/internal-8.md).AdminGetDiscountsParams - -## Hierarchy - -- [`AdminGetDiscountsParams_base`](../modules/internal-8.md#admingetdiscountsparams_base) - - ↳ **`AdminGetDiscountsParams`** - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -AdminGetDiscountsParams\_base.expand - -#### Defined in - -packages/medusa/dist/types/common.d.ts:239 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -AdminGetDiscountsParams\_base.fields - -#### Defined in - -packages/medusa/dist/types/common.d.ts:240 - -___ - -### is\_disabled - -• `Optional` **is\_disabled**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:82 - -___ - -### is\_dynamic - -• `Optional` **is\_dynamic**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:81 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Inherited from - -AdminGetDiscountsParams\_base.limit - -#### Defined in - -packages/medusa/dist/types/common.d.ts:244 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -AdminGetDiscountsParams\_base.offset - -#### Defined in - -packages/medusa/dist/types/common.d.ts:243 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:80 - -___ - -### rule - -• `Optional` **rule**: [`AdminGetDiscountsDiscountRuleParams`](internal-8.AdminGetDiscountsDiscountRuleParams.md) - -#### Defined in - -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.AdminListOrdersSelector.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminListOrdersSelector.md deleted file mode 100644 index 14219f4da7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminListOrdersSelector.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminListOrdersSelector - -[internal](../modules/internal-8.md).AdminListOrdersSelector - -## Hierarchy - -- **`AdminListOrdersSelector`** - - ↳ [`AdminGetOrdersParams`](internal-8.internal.AdminGetOrdersParams.md) - -## Properties - -### canceled\_at - -• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:101 - -___ - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:94 - -___ - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:102 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:98 - -___ - -### customer\_id - -• `Optional` **customer\_id**: `string` - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:95 - -___ - -### display\_id - -• `Optional` **display\_id**: `string` - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:93 - -___ - -### email - -• `Optional` **email**: `string` - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:96 - -___ - -### fulfillment\_status - -• `Optional` **fulfillment\_status**: `string`[] - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:91 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:89 - -___ - -### payment\_status - -• `Optional` **payment\_status**: `string`[] - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:92 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:88 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` \| `string`[] - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:97 - -___ - -### sales\_channel\_id - -• `Optional` **sales\_channel\_id**: `string`[] - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:100 - -___ - -### status - -• `Optional` **status**: `string`[] - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:90 - -___ - -### tax\_rate - -• `Optional` **tax\_rate**: `string` - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:99 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -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 deleted file mode 100644 index 72be00d831..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditions.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -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 deleted file mode 100644 index 5542eb6025..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsCondition.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -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-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md deleted file mode 100644 index f27df453b6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostDiscountsDiscountConditionsConditionBatchParams - -[internal](../modules/internal-8.md).AdminPostDiscountsDiscountConditionsConditionBatchParams - -## Hierarchy - -- [`FindParams`](internal-6.FindParams.md) - - ↳ **`AdminPostDiscountsDiscountConditionsConditionBatchParams`** - -## 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.AdminPostDiscountsDiscountConditionsConditionBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchReq.md deleted file mode 100644 index 14a88e2508..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchReq.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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-8.AdminPostDiscountsDiscountConditionsConditionParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md deleted file mode 100644 index 7e1140ee8c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostDiscountsDiscountConditionsConditionParams - -[internal](../modules/internal-8.md).AdminPostDiscountsDiscountConditionsConditionParams - -## Hierarchy - -- [`FindParams`](internal-6.FindParams.md) - - ↳ **`AdminPostDiscountsDiscountConditionsConditionParams`** - -## 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.AdminPostDiscountsDiscountConditionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsParams.md deleted file mode 100644 index 33586c9db9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostDiscountsDiscountConditionsParams - -[internal](../modules/internal-8.md).AdminPostDiscountsDiscountConditionsParams - -## Hierarchy - -- [`FindParams`](internal-6.FindParams.md) - - ↳ **`AdminPostDiscountsDiscountConditionsParams`** - -## 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.AdminPostDiscountsDiscountDynamicCodesReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountDynamicCodesReq.md deleted file mode 100644 index 3a26d26ee2..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountDynamicCodesReq.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -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 deleted file mode 100644 index be97f15c87..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountReq.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -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 deleted file mode 100644 index 82b419932a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountRule.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index 40af346af9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsReq.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -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.AdminPriceSelectionParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPriceSelectionParams.md deleted file mode 100644 index 632c99a86a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPriceSelectionParams.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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 deleted file mode 100644 index a0755472dc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminProductCategoriesReqBase.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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 deleted file mode 100644 index 29b977c00c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminUpdateDiscountRule.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index 79b204ec8b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminUpsertCondition.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -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-8.AdminUpsertConditionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminUpsertConditionsReq.md deleted file mode 100644 index eb89d4d10e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminUpsertConditionsReq.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminUpsertConditionsReq - -[internal](../modules/internal-8.md).AdminUpsertConditionsReq - -## Hierarchy - -- **`AdminUpsertConditionsReq`** - - ↳ [`AdminPostDiscountsDiscountConditions`](internal-8.AdminPostDiscountsDiscountConditions.md) - - ↳ [`AdminPostDiscountsDiscountConditionsCondition`](internal-8.AdminPostDiscountsDiscountConditionsCondition.md) - - ↳ [`AdminCreateCondition`](internal-8.AdminCreateCondition.md) - - ↳ [`AdminUpsertCondition`](internal-8.AdminUpsertCondition.md) - -## Properties - -### customer\_groups - -• `Optional` **customer\_groups**: `string`[] - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:21 - -___ - -### product\_collections - -• `Optional` **product\_collections**: `string`[] - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:18 - -___ - -### product\_tags - -• `Optional` **product\_tags**: `string`[] - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:20 - -___ - -### product\_types - -• `Optional` **product\_types**: `string`[] - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:19 - -___ - -### products - -• `Optional` **products**: `string`[] - -#### Defined in - -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 deleted file mode 100644 index 420fe345be..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Blob.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -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 deleted file mode 100644 index 097b02d577..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.CustomShippingOption.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 0f860f3a9e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroup-1.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index d695aa7515..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroup.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index 5b014eb96a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroupUpdate.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 134b6fb82b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Discount-1.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Discount - -[internal](../modules/internal-8.md).Discount - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -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 deleted file mode 100644 index 7c80f57b67..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Discount-2.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index 3c23e75fb4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Discount-3.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index b8993bb57d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Discount.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Discount - -[internal](../modules/internal-8.md).Discount - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -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 deleted file mode 100644 index cd33c624d9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Duplex.md +++ /dev/null @@ -1,4811 +0,0 @@ ---- -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 deleted file mode 100644 index 267ef8376c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.EventEmitter-1.md +++ /dev/null @@ -1,1174 +0,0 @@ ---- -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 deleted file mode 100644 index ed06e36c45..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.FilterableCartProps.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 deleted file mode 100644 index 67775bd958..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.FilterableDiscountProps.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index f880643c18..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.FilterableLineItemAdjustmentProps.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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-8.FilterableProductProps.md b/www/apps/docs/content/references/js-client/classes/internal-8.FilterableProductProps.md deleted file mode 100644 index 1b31be4f72..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.FilterableProductProps.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: FilterableProductProps - -[internal](../modules/internal-8.md).FilterableProductProps - -API Level DTOs + Validation rules - -## Hierarchy - -- **`FilterableProductProps`** - - ↳ [`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 - -packages/medusa/dist/types/product.d.ts:13 - -___ - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/types/product.d.ts:24 - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/types/product.d.ts:26 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/medusa/dist/types/product.d.ts:16 - -___ - -### discount\_condition\_id - -• `Optional` **discount\_condition\_id**: `string` - -#### Defined in - -packages/medusa/dist/types/product.d.ts:21 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -packages/medusa/dist/types/product.d.ts:17 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] - -#### Defined in - -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 - -___ - -### is\_giftcard - -• `Optional` **is\_giftcard**: `boolean` - -#### Defined in - -packages/medusa/dist/types/product.d.ts:18 - -___ - -### price\_list\_id - -• `Optional` **price\_list\_id**: `string`[] - -#### Defined in - -packages/medusa/dist/types/product.d.ts:12 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/types/product.d.ts:10 - -___ - -### sales\_channel\_id - -• `Optional` **sales\_channel\_id**: `string`[] - -#### Defined in - -packages/medusa/dist/types/product.d.ts:20 - -___ - -### status - -• `Optional` **status**: [`ProductStatus`](../enums/internal-3.ProductStatus.md)[] - -#### Defined in - -packages/medusa/dist/types/product.d.ts:11 - -___ - -### tags - -• `Optional` **tags**: `string`[] - -#### Defined in - -packages/medusa/dist/types/product.d.ts:14 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -packages/medusa/dist/types/product.d.ts:15 - -___ - -### type\_id - -• `Optional` **type\_id**: `string`[] - -#### Defined in - -packages/medusa/dist/types/product.d.ts:19 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -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 deleted file mode 100644 index d8c650b26f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.FilterableProductVariantProps.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -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 deleted file mode 100644 index c7a0a795ce..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.FlagRouter.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -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 deleted file mode 100644 index 728f1a226f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.FulfillmentService.md +++ /dev/null @@ -1,452 +0,0 @@ ---- -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 deleted file mode 100644 index f89222f3b9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.GiftCard-1.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index ebd01aa184..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.GiftCard.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index ab928365f5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Image.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 1a9a19d881..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Item-1.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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 deleted file mode 100644 index 2fc3c219ba..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Item-2.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index ffca8819cd..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Item-3.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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 deleted file mode 100644 index d6db3bf499..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Item-4.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 02ff813b28..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Item-5.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index a3d2fe5f13..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Item-6.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index d9ffdbfbeb..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Item.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Item - -[internal](../modules/internal-8.md).Item - -## Properties - -### 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:209 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:208 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:205 - -___ - -### unit\_price - -• `Optional` **unit\_price**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:206 - -___ - -### variant\_id - -• `Optional` **variant\_id**: `string` - -#### Defined in - -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 deleted file mode 100644 index 319564a90f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.MedusaError.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -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 deleted file mode 100644 index 9cab991ca7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.NotificationProvider.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 3ba76ccdfd..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.OptionRequirement-1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 deleted file mode 100644 index 613179f9dd..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.OptionRequirement.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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-8.OrdersReturnItem.md b/www/apps/docs/content/references/js-client/classes/internal-8.OrdersReturnItem.md deleted file mode 100644 index b22f21c109..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.OrdersReturnItem.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: OrdersReturnItem - -[internal](../modules/internal-8.md).OrdersReturnItem - -## Properties - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:106 - -___ - -### note - -• `Optional` **note**: `string` - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:109 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:107 - -___ - -### reason\_id - -• `Optional` **reason\_id**: `string` - -#### Defined in - -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 deleted file mode 100644 index 9850e7131e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.PassThrough.md +++ /dev/null @@ -1,4446 +0,0 @@ ---- -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 deleted file mode 100644 index 6aa066002d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.PaymentMethod.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index e02e8cb260..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.PaymentService.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -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 deleted file mode 100644 index e5678ae755..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.PriceSelectionParams.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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 deleted file mode 100644 index d9fdd5b1f6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductBatchProductCategory.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index 4032559a31..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductBatchSalesChannel.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index 108d4fb764..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductOptionReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index 3a813dd196..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductProductCategoryReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index 4735488419..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductSalesChannelReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index ba99498449..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductTagReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 59f5d6c73d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductTypeReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 1d53de4e90..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-1.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index eb6185c928..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-2.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index 49c6b7cf96..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-3.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index c23efd9c75..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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-8.ProductVariantPricesCreateReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantPricesCreateReq.md deleted file mode 100644 index 03cfaf1b8f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantPricesCreateReq.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductVariantPricesCreateReq - -[internal](../modules/internal-8.md).ProductVariantPricesCreateReq - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -packages/medusa/dist/types/product-variant.d.ts:121 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Defined in - -packages/medusa/dist/types/product-variant.d.ts:120 - -___ - -### max\_quantity - -• `Optional` **max\_quantity**: `number` - -#### Defined in - -packages/medusa/dist/types/product-variant.d.ts:123 - -___ - -### min\_quantity - -• `Optional` **min\_quantity**: `number` - -#### Defined in - -packages/medusa/dist/types/product-variant.d.ts:122 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -packages/medusa/dist/types/product-variant.d.ts:119 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantPricesUpdateReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantPricesUpdateReq.md deleted file mode 100644 index 2d7663efe6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantPricesUpdateReq.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductVariantPricesUpdateReq - -[internal](../modules/internal-8.md).ProductVariantPricesUpdateReq - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -packages/medusa/dist/types/product-variant.d.ts:114 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Defined in - -packages/medusa/dist/types/product-variant.d.ts:113 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -packages/medusa/dist/types/product-variant.d.ts:111 - -___ - -### max\_quantity - -• `Optional` **max\_quantity**: `number` - -#### Defined in - -packages/medusa/dist/types/product-variant.d.ts:116 - -___ - -### min\_quantity - -• `Optional` **min\_quantity**: `number` - -#### Defined in - -packages/medusa/dist/types/product-variant.d.ts:115 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -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 deleted file mode 100644 index 5ace4e8fd5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantReq-1.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -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 deleted file mode 100644 index 0bcd76542b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantReq.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -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 deleted file mode 100644 index 2a93808729..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Readable.md +++ /dev/null @@ -1,3202 +0,0 @@ ---- -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 deleted file mode 100644 index 51f6872163..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ReadableBase.md +++ /dev/null @@ -1,3356 +0,0 @@ ---- -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 deleted file mode 100644 index ef801b3f6e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ReturnItem.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index b0d0b6f694..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-1.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 584504394d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-2.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 81cab6830e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-3.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index 2587e86151..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index d66f6e09cd..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-1.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index ca44b6d211..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-2.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index c69ae4eb1a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-3.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index 862c994c64..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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/draft-orders/create-draft-order.d.ts:198 - -___ - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:197 - -___ - -### price - -• `Optional` **price**: `number` - -#### Defined in - -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 deleted file mode 100644 index e63c32151f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.StockLocationAddress-1.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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 deleted file mode 100644 index a34380e1f7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.StockLocationAddress.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -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 deleted file mode 100644 index 2167a1d25a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Stream.md +++ /dev/null @@ -1,1228 +0,0 @@ ---- -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 deleted file mode 100644 index c05b3338ec..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Tag.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index d863fd579a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Transform.md +++ /dev/null @@ -1,4450 +0,0 @@ ---- -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 deleted file mode 100644 index cd63c25796..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.WritableBase.md +++ /dev/null @@ -1,2964 +0,0 @@ ---- -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 deleted file mode 100644 index 12b43c5ef3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal-2.Writable.md +++ /dev/null @@ -1,2844 +0,0 @@ ---- -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 deleted file mode 100644 index 95c0b6e72f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal-5.md +++ /dev/null @@ -1,1222 +0,0 @@ ---- -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 deleted file mode 100644 index 5b059e1dad..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractBatchJobStrategy.md +++ /dev/null @@ -1,406 +0,0 @@ ---- -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 deleted file mode 100644 index 018675da54..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractCartCompletionStrategy.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -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 deleted file mode 100644 index 61ba369efe..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractFileService.md +++ /dev/null @@ -1,388 +0,0 @@ ---- -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 deleted file mode 100644 index 6410701fa6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractFulfillmentService.md +++ /dev/null @@ -1,392 +0,0 @@ ---- -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 deleted file mode 100644 index 4dda8b5114..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractNotificationService.md +++ /dev/null @@ -1,304 +0,0 @@ ---- -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 deleted file mode 100644 index 2cda0d4f8b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPaymentProcessor.md +++ /dev/null @@ -1,326 +0,0 @@ ---- -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 deleted file mode 100644 index 9ac35a4b4b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPaymentService.md +++ /dev/null @@ -1,653 +0,0 @@ ---- -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 deleted file mode 100644 index d71c821acd..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPriceSelectionStrategy.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -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 deleted file mode 100644 index 4eaf18a23e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractTaxService.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -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 deleted file mode 100644 index 05e3241f77..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminCreateUserRequest.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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 deleted file mode 100644 index 753f1a7663..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index e02caeeff4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 4e8a42480a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePriceListPricesPricesReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index fbfe836433..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index 37089319af..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 2c7a1a0837..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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 deleted file mode 100644 index 143f75a0a1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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 deleted file mode 100644 index eb64c4072d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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 deleted file mode 100644 index fab506d0cb..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index 50a6f5ea2b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 441dee37fa..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -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 deleted file mode 100644 index 68c8d130ab..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 9c44c436c1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsReq.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -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 deleted file mode 100644 index 07c76a00b0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index cb151fa6dc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -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 deleted file mode 100644 index ce7cc82c23..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteUploadsReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index 207cc96d32..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDiscountParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 4c2408ed1a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDiscountsDiscountCodeParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index e65747c8d3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDraftOrdersParams.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 deleted file mode 100644 index 66d0cacf4d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetGiftCardsParams.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 deleted file mode 100644 index ba464f2bba..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsItemLocationLevelsParams.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -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 deleted file mode 100644 index c23ec8551b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsItemParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 9b58c872e6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsParams.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -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 deleted file mode 100644 index b77814e944..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetNotesParams.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 deleted file mode 100644 index 8f96dc9b02..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetNotificationsParams.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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 deleted file mode 100644 index 6f2a82c647..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetOrdersOrderParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 256322fe6c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetOrdersParams.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -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 deleted file mode 100644 index 09afe34931..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPaymentCollectionsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 57fa24e174..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPriceListPaginationParams.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -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-8.internal.AdminGetPriceListsPriceListProductsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPriceListsPriceListProductsParams.md deleted file mode 100644 index 78eb6652d9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPriceListsPriceListProductsParams.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetPriceListsPriceListProductsParams - -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetPriceListsPriceListProductsParams - -## Hierarchy - -- [`AdminGetPriceListsPriceListProductsParams_base`](../modules/internal-8.md#admingetpricelistspricelistproductsparams_base) - - ↳ **`AdminGetPriceListsPriceListProductsParams`** - -## Properties - -### collection\_id - -• `Optional` **collection\_id**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:170 - -___ - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:178 - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:180 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:173 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -AdminGetPriceListsPriceListProductsParams\_base.expand - -#### Defined in - -packages/medusa/dist/types/common.d.ts:239 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -AdminGetPriceListsPriceListProductsParams\_base.fields - -#### Defined in - -packages/medusa/dist/types/common.d.ts:240 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:174 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:167 - -___ - -### is\_giftcard - -• `Optional` **is\_giftcard**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:175 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Inherited from - -AdminGetPriceListsPriceListProductsParams\_base.limit - -#### Defined in - -packages/medusa/dist/types/common.d.ts:244 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -AdminGetPriceListsPriceListProductsParams\_base.offset - -#### Defined in - -packages/medusa/dist/types/common.d.ts:243 - -___ - -### order - -• `Optional` **order**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:177 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:168 - -___ - -### status - -• `Optional` **status**: [`ProductStatus`](../enums/internal-3.ProductStatus.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:169 - -___ - -### tags - -• `Optional` **tags**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:171 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:172 - -___ - -### type - -• `Optional` **type**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:176 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -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 deleted file mode 100644 index 180c280ab5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductCategoriesParams.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -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 deleted file mode 100644 index ae96332895..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductCategoryParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 93f4508672..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTagsPaginationParams.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index d5e1acd444..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTagsParams.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -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-8.internal.AdminGetProductTypesParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTypesParams.md deleted file mode 100644 index 6f9c393d67..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTypesParams.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetProductTypesParams - -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetProductTypesParams - -## Hierarchy - -- [`FindPaginationParams`](internal-4.FindPaginationParams.md) - - ↳ **`AdminGetProductTypesParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:127 - -___ - -### discount\_condition\_id - -• `Optional` **discount\_condition\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:130 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:124 - -___ - -### 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/admin/product-types/list-product-types.d.ts:129 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:125 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:128 - -___ - -### value - -• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) - -#### Defined in - -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 deleted file mode 100644 index 5c4e7e80b3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductsParams.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -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 deleted file mode 100644 index a17c48ce59..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductsVariantsParams.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index 29bde73c0c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsPaginationParams.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index 327f0a7b07..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsParams.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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.AdminGetReservationsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetReservationsParams.md deleted file mode 100644 index 1ccb12bede..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetReservationsParams.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -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 deleted file mode 100644 index cfc5591d75..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetReturnsParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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-8.internal.AdminGetSalesChannelsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetSalesChannelsParams.md deleted file mode 100644 index e3fe824ed6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetSalesChannelsParams.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetSalesChannelsParams - -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetSalesChannelsParams - -## Hierarchy - -- [`AdminGetSalesChannelsParams_base`](../modules/internal-8.md#admingetsaleschannelsparams_base) - - ↳ **`AdminGetSalesChannelsParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:138 - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:140 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:137 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -AdminGetSalesChannelsParams\_base.expand - -#### Defined in - -packages/medusa/dist/types/common.d.ts:239 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -AdminGetSalesChannelsParams\_base.fields - -#### Defined in - -packages/medusa/dist/types/common.d.ts:240 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:134 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Inherited from - -AdminGetSalesChannelsParams\_base.limit - -#### Defined in - -packages/medusa/dist/types/common.d.ts:244 - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:136 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -AdminGetSalesChannelsParams\_base.offset - -#### Defined in - -packages/medusa/dist/types/common.d.ts:243 - -___ - -### order - -• `Optional` **order**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:141 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:135 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -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 deleted file mode 100644 index 13492c9187..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetShippingOptionsParams.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 deleted file mode 100644 index b743d71e03..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetStockLocationsLocationParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 72ee0d8f37..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetStockLocationsParams.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -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 deleted file mode 100644 index c794c53c45..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetSwapsParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 611a4567a7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetTaxRatesParams.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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 deleted file mode 100644 index 3924868e46..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetTaxRatesTaxRateParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 20451a78ad..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetVariantParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index dad7b8ce8b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetVariantsParams.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -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 deleted file mode 100644 index 0545abdccf..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostAnalyticsConfigAnalyticsConfigReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index e6a072cfe1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostAnalyticsConfigReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 5fcdff0764..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDiscountsDiscountParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 547935fd5f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDiscountsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 6b6fee4cb6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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 deleted file mode 100644 index c2ba983b3a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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 deleted file mode 100644 index 97ab75af0d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderReq.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -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 deleted file mode 100644 index 9df94a4626..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersReq.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -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 deleted file mode 100644 index 411454c49d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostGiftCardsGiftCardReq.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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 deleted file mode 100644 index 890a0da589..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostGiftCardsReq.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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 deleted file mode 100644 index 0dbd55c2ad..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsInventoryItemParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 9d8f73ee62..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsInventoryItemReq.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -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 deleted file mode 100644 index 474783fba6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index d329586844..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index d1e86ed3a7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 48ec3ed3db..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsReq.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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 deleted file mode 100644 index e412c6e1a7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index e0f28e0f5d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsReq.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -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 deleted file mode 100644 index a52b51e238..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesInviteAcceptReq.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index f1da530da4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesInviteAcceptUserReq.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 deleted file mode 100644 index 445ace22be..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesReq.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -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 deleted file mode 100644 index 30ac3681a1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotesNoteReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index 5d0e007482..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotesReq.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -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 deleted file mode 100644 index ba72f737ae..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotificationsNotificationResendReq.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -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 deleted file mode 100644 index 0730734d95..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsEditLineItemsLineItemReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index e43d2f9e1a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsEditLineItemsReq.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -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 deleted file mode 100644 index 62f3715632..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsOrderEditReq.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -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 deleted file mode 100644 index 1fb4f9f2a4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsReq.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -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 deleted file mode 100644 index e4edd5b699..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsRequestConfirmationReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index 5846ea5d3c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersClaimCancel.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index b17413d584..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersClaimFulfillmentsCancelParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index c06091e114..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderArchiveParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index c823f9efa4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCancel.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index ad0ad86123..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCaptureParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 41527b3c3c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 5eb52cee43..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -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 deleted file mode 100644 index 90110a010c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 8533a1f48d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimReq.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -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 deleted file mode 100644 index d8acc0a0fb..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 1af51532a5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 20cb51c4b6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 5a243fd32f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsReq.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -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 deleted file mode 100644 index ead08f2230..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCompleteParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 0533c8f82b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillementsCancelParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index e2fdc3b67a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 9650839fb2..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsReq.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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 deleted file mode 100644 index 1620c0c1b6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 90d6d757dc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderRefundsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index dd3db9ebcf..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderRefundsReq.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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 deleted file mode 100644 index 3f24e75fb4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReq.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -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 deleted file mode 100644 index 166e27773c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReturnsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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.AdminPostOrdersOrderShipmentParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShipmentParams.md deleted file mode 100644 index 5416e820b8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShipmentParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 9dbb946b06..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShipmentReq.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -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 deleted file mode 100644 index 6ee3e0cbac..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index d863e28ace..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsReq.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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 deleted file mode 100644 index f0407f0f29..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 34a9f394de..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.md deleted file mode 100644 index 08e6a8ce08..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index ae328c5846..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -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 deleted file mode 100644 index d7f88ceef2..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index ffc8a3724b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 43925a402b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -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 deleted file mode 100644 index 15109f269d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersSwapCancelParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 14018b6f1e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPaymentRefundsReq.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -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.AdminPostPriceListsPriceListPriceListReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListsPriceListPriceListReq.md deleted file mode 100644 index 46fb819840..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListsPriceListPriceListReq.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -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 deleted file mode 100644 index 1894b0c8d9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListsPriceListReq.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -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 deleted file mode 100644 index a0194617c7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 2a885f75e8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index f4979817a5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchReq.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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 deleted file mode 100644 index 2c86fcfd2e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryReq.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -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 deleted file mode 100644 index b919f68c16..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index fbfac6e6b5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesReq.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -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 deleted file mode 100644 index 02a1b47f8c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductMetadataReq.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -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 deleted file mode 100644 index 97781105ce..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductOptionsOption.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index 5aa6bd7f13..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductOptionsReq.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -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 deleted file mode 100644 index 5982ff44f0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductReq.md +++ /dev/null @@ -1,458 +0,0 @@ ---- -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 deleted file mode 100644 index 0e21cd234a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductVariantsReq.md +++ /dev/null @@ -1,307 +0,0 @@ ---- -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 deleted file mode 100644 index f7e2b44f23..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductVariantsVariantReq.md +++ /dev/null @@ -1,304 +0,0 @@ ---- -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 deleted file mode 100644 index 77862029d5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsReq.md +++ /dev/null @@ -1,497 +0,0 @@ ---- -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 deleted file mode 100644 index 19c3083ac1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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 deleted file mode 100644 index 29052d5baf..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -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 deleted file mode 100644 index ac7c4c3b37..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeysReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index c64c8eaef7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionCountriesReq.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -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 deleted file mode 100644 index 0f2fa0543f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionFulfillmentProvidersReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index f58461c30c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionPaymentProvidersReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index 671dbfa96e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionReq.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -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 deleted file mode 100644 index e34f2723e6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsReq.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -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 deleted file mode 100644 index 492a9363c8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReservationsReq.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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 deleted file mode 100644 index 4a72547b76..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReservationsReservationReq.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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 deleted file mode 100644 index b9225d46ba..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnReasonsReasonReq.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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 deleted file mode 100644 index 6eefc9af47..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnReasonsReq.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -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 deleted file mode 100644 index 18198f998f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnsReturnReceiveReq.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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 deleted file mode 100644 index 3cdb30304a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsChannelProductsBatchReq.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -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 deleted file mode 100644 index 5c6ee9dc1a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsChannelStockLocationsReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index 7b3fe51116..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsReq.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -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 deleted file mode 100644 index 620b48a96c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsSalesChannelReq.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -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 deleted file mode 100644 index 41b0e2434d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingOptionsOptionReq.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -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 deleted file mode 100644 index 381d9d8456..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingOptionsReq.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -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 deleted file mode 100644 index 45475d38a9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingProfilesProfileReq.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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 deleted file mode 100644 index d8d299b8c3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingProfilesReq.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -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 deleted file mode 100644 index 69b05285f4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsLocationParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index a0822b5dc6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsLocationReq.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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 deleted file mode 100644 index 4c6c741da8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index a8f874366a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsReq.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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 deleted file mode 100644 index 0c6ae2a98b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStoreReq.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -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 deleted file mode 100644 index ae5854953f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 7fb8b837e1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesReq.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -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 deleted file mode 100644 index 235db9282b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 9817c06796..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index bf97707a10..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesReq.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -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 deleted file mode 100644 index 5d484a7312..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index a751a42241..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsReq.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -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 deleted file mode 100644 index 41b37c9b96..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateReq.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -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 deleted file mode 100644 index e4702de7b6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index e735f45e4b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -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 deleted file mode 100644 index 5eb1b535e4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostUploadsDownloadUrlReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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-8.internal.AdminPriceListPricesCreateReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPriceListPricesCreateReq.md deleted file mode 100644 index 53abe7871a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPriceListPricesCreateReq.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPriceListPricesCreateReq - -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPriceListPricesCreateReq - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:35 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:34 - -___ - -### max\_quantity - -• `Optional` **max\_quantity**: `number` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:38 - -___ - -### min\_quantity - -• `Optional` **min\_quantity**: `number` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:37 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:33 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:36 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPriceListPricesUpdateReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPriceListPricesUpdateReq.md deleted file mode 100644 index 658b108e3c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPriceListPricesUpdateReq.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPriceListPricesUpdateReq - -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPriceListPricesUpdateReq - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:28 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:26 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:24 - -___ - -### max\_quantity - -• `Optional` **max\_quantity**: `number` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:30 - -___ - -### min\_quantity - -• `Optional` **min\_quantity**: `number` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:29 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:25 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -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 deleted file mode 100644 index 247e69e2da..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminRegionsRes.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 deleted file mode 100644 index 149a9ebefb..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminResetPasswordRequest.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index af2000334e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminResetPasswordTokenRequest.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -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 deleted file mode 100644 index 5f4410740f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminUpdatePaymentCollectionsReq.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -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 deleted file mode 100644 index e4a6b1e4c4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminUpdateUserRequest.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -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 deleted file mode 100644 index e4ade935ec..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AnalyticsConfig.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -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 deleted file mode 100644 index 86a3ba81bd..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AnalyticsConfigService.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -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 deleted file mode 100644 index 1da37b53f4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AuthService.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -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 deleted file mode 100644 index def88341dc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.BatchJobService.md +++ /dev/null @@ -1,497 +0,0 @@ ---- -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 deleted file mode 100644 index 2a4dba965c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.CartService.md +++ /dev/null @@ -1,1499 +0,0 @@ ---- -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 deleted file mode 100644 index 0766653c44..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ClaimItemService.md +++ /dev/null @@ -1,345 +0,0 @@ ---- -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 deleted file mode 100644 index 14f9a29523..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ClaimService.md +++ /dev/null @@ -1,625 +0,0 @@ ---- -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 deleted file mode 100644 index 3817af510b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.CurrencyService.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -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 deleted file mode 100644 index d5d6f2f81e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomShippingOption.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -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 deleted file mode 100644 index 36e91d6bcb..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomShippingOptionService.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -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 deleted file mode 100644 index e073245b4e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomerGroupService.md +++ /dev/null @@ -1,412 +0,0 @@ ---- -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 deleted file mode 100644 index 7852e43a8c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomerService.md +++ /dev/null @@ -1,669 +0,0 @@ ---- -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 deleted file mode 100644 index 501437022f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionCustomerGroup.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index 2d130ba929..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProduct.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index e356981c67..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductCollection.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index d804e616dc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductTag.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index 9f717d65d8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductType.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index 8b0f8b5192..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionService.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -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 deleted file mode 100644 index 46aabbd8db..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountService.md +++ /dev/null @@ -1,843 +0,0 @@ ---- -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 deleted file mode 100644 index 1dfac6f314..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DraftOrderService.md +++ /dev/null @@ -1,498 +0,0 @@ ---- -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 deleted file mode 100644 index c86e543d55..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.EmptyQueryParams.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -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 deleted file mode 100644 index 7f7a7a9b3d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.EventBusService.md +++ /dev/null @@ -1,447 +0,0 @@ ---- -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 deleted file mode 100644 index 2c6dabf5c3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.FilterableBatchJobProps.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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-8.internal.FilterablePriceListProps.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.FilterablePriceListProps.md deleted file mode 100644 index 6c49d01a9f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.FilterablePriceListProps.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: FilterablePriceListProps - -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).FilterablePriceListProps - -## Hierarchy - -- **`FilterablePriceListProps`** - - ↳ [`AdminGetPriceListPaginationParams`](internal-8.internal.AdminGetPriceListPaginationParams.md) - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:19 - -___ - -### customer\_groups - -• `Optional` **customer\_groups**: `string`[] - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:16 - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:21 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:17 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:12 - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:15 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:13 - -___ - -### status - -• `Optional` **status**: [`PriceListStatus`](../enums/internal-3.PriceListStatus.md)[] - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:14 - -___ - -### type - -• `Optional` **type**: [`PriceListType`](../enums/internal-3.PriceListType.md)[] - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:18 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -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 deleted file mode 100644 index e04cb2db5e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.FulfillmentOption.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index d05b712d27..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.FulfillmentProviderService.md +++ /dev/null @@ -1,459 +0,0 @@ ---- -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 deleted file mode 100644 index 89830487d5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetOrderEditsOrderEditParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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-8.internal.GetOrderEditsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetOrderEditsParams.md deleted file mode 100644 index b4f07f1251..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetOrderEditsParams.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: GetOrderEditsParams - -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).GetOrderEditsParams - -## Hierarchy - -- [`GetOrderEditsParams_base`](../modules/internal-8.md#getordereditsparams_base) - - ↳ **`GetOrderEditsParams`** - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -GetOrderEditsParams\_base.expand - -#### Defined in - -packages/medusa/dist/types/common.d.ts:239 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -GetOrderEditsParams\_base.fields - -#### Defined in - -packages/medusa/dist/types/common.d.ts:240 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Inherited from - -GetOrderEditsParams\_base.limit - -#### Defined in - -packages/medusa/dist/types/common.d.ts:244 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -GetOrderEditsParams\_base.offset - -#### Defined in - -packages/medusa/dist/types/common.d.ts:243 - -___ - -### order\_id - -• `Optional` **order\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:65 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -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 deleted file mode 100644 index 40e9c24c6d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPaymentsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 8fffbc8ccc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPublishableApiKeySalesChannelsParams.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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-8.internal.GetPublishableApiKeysParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPublishableApiKeysParams.md deleted file mode 100644 index e73e84931f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPublishableApiKeysParams.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: GetPublishableApiKeysParams - -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).GetPublishableApiKeysParams - -## Hierarchy - -- [`GetPublishableApiKeysParams_base`](../modules/internal-8.md#getpublishableapikeysparams_base) - - ↳ **`GetPublishableApiKeysParams`** - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -GetPublishableApiKeysParams\_base.expand - -#### Defined in - -packages/medusa/dist/types/common.d.ts:239 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -GetPublishableApiKeysParams\_base.fields - -#### Defined in - -packages/medusa/dist/types/common.d.ts:240 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Inherited from - -GetPublishableApiKeysParams\_base.limit - -#### Defined in - -packages/medusa/dist/types/common.d.ts:244 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -GetPublishableApiKeysParams\_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-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 deleted file mode 100644 index 314f0176e3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.GiftCardService.md +++ /dev/null @@ -1,496 +0,0 @@ ---- -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 deleted file mode 100644 index 6d71473a6a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.IAdminPostUploadsFileReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 6d038f85b2..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.IdempotencyKey.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -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 deleted file mode 100644 index dc1561ba2e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.IdempotencyKeyService.md +++ /dev/null @@ -1,353 +0,0 @@ ---- -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 deleted file mode 100644 index 21868e75a7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.Invite.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -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 deleted file mode 100644 index 69635257bb..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.Item.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 1e2e2815d3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.LineItemAdjustmentService.md +++ /dev/null @@ -1,410 +0,0 @@ ---- -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 deleted file mode 100644 index 61c3550722..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.LineItemService.md +++ /dev/null @@ -1,605 +0,0 @@ ---- -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 deleted file mode 100644 index 0b24bff318..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.MiddlewareService.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -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 deleted file mode 100644 index 41a70ee561..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.NewTotalsService.md +++ /dev/null @@ -1,495 +0,0 @@ ---- -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 deleted file mode 100644 index c9b00c295a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.Note.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -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 deleted file mode 100644 index ce208aec0b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.NoteService.md +++ /dev/null @@ -1,374 +0,0 @@ ---- -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 deleted file mode 100644 index b21c9dcc9c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.Notification.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -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 deleted file mode 100644 index fbbb9df5c1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.NotificationService.md +++ /dev/null @@ -1,496 +0,0 @@ ---- -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 deleted file mode 100644 index b6372cd46c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.NumericalComparisonOperator.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index eed0157779..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.Oauth.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index 7738fc1e14..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.OauthService.md +++ /dev/null @@ -1,398 +0,0 @@ ---- -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 deleted file mode 100644 index 41f47db423..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderEditItemChangeService.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -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 deleted file mode 100644 index bd2c9795bb..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderEditService.md +++ /dev/null @@ -1,707 +0,0 @@ ---- -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 deleted file mode 100644 index 87f0e53c73..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderService.md +++ /dev/null @@ -1,1155 +0,0 @@ ---- -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 deleted file mode 100644 index ba72d4e175..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.PaymentCollectionService.md +++ /dev/null @@ -1,483 +0,0 @@ ---- -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 deleted file mode 100644 index 5bd7737819..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.PaymentProviderService.md +++ /dev/null @@ -1,832 +0,0 @@ ---- -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 deleted file mode 100644 index a2ecbd2cea..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.PriceListService.md +++ /dev/null @@ -1,653 +0,0 @@ ---- -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 deleted file mode 100644 index 04d9918a12..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.PricingService.md +++ /dev/null @@ -1,540 +0,0 @@ ---- -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 deleted file mode 100644 index 4759a96233..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductCategoryService.md +++ /dev/null @@ -1,549 +0,0 @@ ---- -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 deleted file mode 100644 index f18b709ba2..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductCollectionService.md +++ /dev/null @@ -1,457 +0,0 @@ ---- -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 deleted file mode 100644 index e23a2bf0e9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductService.md +++ /dev/null @@ -1,866 +0,0 @@ ---- -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 deleted file mode 100644 index 68022f477c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTaxRate.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index 3a9ce4886a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTypeService.md +++ /dev/null @@ -1,274 +0,0 @@ ---- -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 deleted file mode 100644 index 90bac9c402..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTypeTaxRate.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index bde738e266..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantInventoryService.md +++ /dev/null @@ -1,674 +0,0 @@ ---- -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 deleted file mode 100644 index c86521fc0d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantMoneyAmount.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -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 deleted file mode 100644 index dad39fa593..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantService.md +++ /dev/null @@ -1,869 +0,0 @@ ---- -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 deleted file mode 100644 index 5a79816e2b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.PublishableApiKey.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -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 deleted file mode 100644 index db2353c4d9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.PublishableApiKeySalesChannel.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index dae3d4f108..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.RegionService.md +++ /dev/null @@ -1,781 +0,0 @@ ---- -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 deleted file mode 100644 index 5c3a466e28..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ReturnReasonService.md +++ /dev/null @@ -1,307 +0,0 @@ ---- -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 deleted file mode 100644 index c8c533d3f9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ReturnService.md +++ /dev/null @@ -1,601 +0,0 @@ ---- -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 deleted file mode 100644 index 0168b5c71e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelInventoryService.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -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 deleted file mode 100644 index 6714573e04..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelLocationService.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -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 deleted file mode 100644 index b7f0e68fb0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelService.md +++ /dev/null @@ -1,519 +0,0 @@ ---- -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 deleted file mode 100644 index 5d886adf1d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.SearchService.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -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 deleted file mode 100644 index 9c0bc28a38..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingAddressPayload.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index 34bced2b35..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingOptionService.md +++ /dev/null @@ -1,663 +0,0 @@ ---- -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 deleted file mode 100644 index f4ee068317..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingProfileService.md +++ /dev/null @@ -1,635 +0,0 @@ ---- -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 deleted file mode 100644 index def96293c3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingTaxRate.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index c770d86ef3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StagedJob.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index 4642203643..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StagedJobService.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -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 deleted file mode 100644 index 21f89ae59b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.Store.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -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-8.internal.StoreGetCollectionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCollectionsParams.md deleted file mode 100644 index bfa4e90db2..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCollectionsParams.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StoreGetCollectionsParams - -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetCollectionsParams - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:106 - -___ - -### handle - -• `Optional` **handle**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:103 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:104 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:105 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -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 deleted file mode 100644 index 7a7e75bef9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -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 deleted file mode 100644 index ede4aaaa21..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCustomersCustomerOrdersParams.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -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 deleted file mode 100644 index 1d108eaf27..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetOrdersParams.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -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 deleted file mode 100644 index 1c29b1fc5d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetPaymentCollectionsParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index c31928d554..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductCategoriesCategoryParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 998ac26b21..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductCategoriesParams.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -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 deleted file mode 100644 index b755efe084..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductTagsParams.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -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-8.internal.StoreGetProductTypesParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductTypesParams.md deleted file mode 100644 index e6866a49c2..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductTypesParams.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StoreGetProductTypesParams - -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetProductTypesParams - -## Hierarchy - -- [`FindPaginationParams`](internal-4.FindPaginationParams.md) - - ↳ **`StoreGetProductTypesParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/product-types/list-product-types.d.ts:126 - -___ - -### discount\_condition\_id - -• `Optional` **discount\_condition\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/product-types/list-product-types.d.ts:129 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/product-types/list-product-types.d.ts:123 - -___ - -### 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-types/list-product-types.d.ts:128 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/product-types/list-product-types.d.ts:124 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/product-types/list-product-types.d.ts:127 - -___ - -### value - -• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) - -#### Defined in - -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 deleted file mode 100644 index e28a8d95a7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductsPaginationParams.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -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 deleted file mode 100644 index d90a9f795e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductsParams.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -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 deleted file mode 100644 index 94fbe340bb..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetRegionsParams.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index 85dad133b9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetShippingOptionsParams.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 deleted file mode 100644 index 29bb3a8110..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetVariantsParams.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -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 deleted file mode 100644 index f5dc0bf51e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetVariantsVariantParams.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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 deleted file mode 100644 index 12ce3712b0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePaymentCollectionSessionsReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index af0b63d503..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostAuthReq.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -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 deleted file mode 100644 index 05e7b1a00f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartReq.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -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 deleted file mode 100644 index 3c92ce5aaa..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartLineItemsItemReq.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -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 deleted file mode 100644 index d81d2e4a28..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartLineItemsReq.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -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 deleted file mode 100644 index 477c9f6cd0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartPaymentSessionReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index e7a9a286e3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartPaymentSessionUpdateReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index 9e71dabbec..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartReq.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -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 deleted file mode 100644 index 0b36348f5f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartShippingMethodReq.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index 22066adfb7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerAcceptClaimReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index 199cbb5f32..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerOrderClaimReq.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -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 deleted file mode 100644 index d01a5c1176..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerPasswordTokenReq.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -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 deleted file mode 100644 index bc8325683b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerReq.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -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 deleted file mode 100644 index 3c2bb70208..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersReq.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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 deleted file mode 100644 index e3639f2947..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersResetPasswordReq.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -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 deleted file mode 100644 index db7317d178..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostOrderEditsOrderEditDecline.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -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 deleted file mode 100644 index 1c046640f1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -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 deleted file mode 100644 index da43d3cc6a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsReq.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 0103a02b98..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsSessionsReq.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 deleted file mode 100644 index 41a0edef95..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostReturnsReq.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -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 deleted file mode 100644 index 4c9aaa8a08..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostSearchReq.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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 deleted file mode 100644 index afefae894d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostSwapsReq.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -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 deleted file mode 100644 index 77a43b01ef..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreService.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -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 deleted file mode 100644 index bfc4f73055..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StrategyResolverService.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -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 deleted file mode 100644 index 31059c820a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.SwapService.md +++ /dev/null @@ -1,779 +0,0 @@ ---- -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 deleted file mode 100644 index 9d3216e0aa..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.SystemPaymentProviderService.md +++ /dev/null @@ -1,398 +0,0 @@ ---- -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 deleted file mode 100644 index 04f44c9274..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.TaxProviderService.md +++ /dev/null @@ -1,560 +0,0 @@ ---- -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 deleted file mode 100644 index c57615b06c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.TaxRateService.md +++ /dev/null @@ -1,522 +0,0 @@ ---- -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 deleted file mode 100644 index 708e0eabd8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.TokenService.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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 deleted file mode 100644 index 2abfea9784..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.TotalsService.md +++ /dev/null @@ -1,826 +0,0 @@ ---- -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 deleted file mode 100644 index 3faa95e953..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.TransactionBaseService.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -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 deleted file mode 100644 index cd4e584f62..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.UserService.md +++ /dev/null @@ -1,504 +0,0 @@ ---- -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.AddressCreatePayload.md b/www/apps/docs/content/references/js-client/classes/internal.AddressCreatePayload.md deleted file mode 100644 index 09c1b52127..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.AddressCreatePayload.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AddressCreatePayload - -[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 - -• **address\_1**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:231 - -___ - -### address\_2 - -• **address\_2**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:232 - -___ - -### city - -• **city**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:233 - -___ - -### company - -• **company**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:230 - -___ - -### country\_code - -• **country\_code**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:234 - -___ - -### first\_name - -• **first\_name**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:226 - -___ - -### last\_name - -• **last\_name**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:227 - -___ - -### metadata - -• **metadata**: `object` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:229 - -___ - -### phone - -• **phone**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:228 - -___ - -### postal\_code - -• **postal\_code**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:236 - -___ - -### province - -• **province**: `string` - -#### Defined in - -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 deleted file mode 100644 index 7d42d50da5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.AddressPayload.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AddressPayload - -[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`** - - ↳ [`StorePostCustomersCustomerAddressesAddressReq`](internal.StorePostCustomersCustomerAddressesAddressReq.md) - -## Properties - -### address\_1 - -• `Optional` **address\_1**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:160 - -___ - -### address\_2 - -• `Optional` **address\_2**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:161 - -___ - -### city - -• `Optional` **city**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:162 - -___ - -### company - -• `Optional` **company**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:159 - -___ - -### country\_code - -• `Optional` **country\_code**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:163 - -___ - -### first\_name - -• `Optional` **first\_name**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:155 - -___ - -### last\_name - -• `Optional` **last\_name**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:156 - -___ - -### metadata - -• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Defined in - -packages/medusa/dist/types/common.d.ts:158 - -___ - -### phone - -• `Optional` **phone**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:157 - -___ - -### postal\_code - -• `Optional` **postal\_code**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:165 - -___ - -### province - -• `Optional` **province**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:164 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 deleted file mode 100644 index eb33de8960..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostCustomersCustomerAddressesAddressReq - -[internal](../modules/internal.md).StorePostCustomersCustomerAddressesAddressReq - -**`Schema`** - -StorePostCustomersCustomerAddressesAddressReq -anyOf: - - $ref: "#/components/schemas/AddressPayload" - -## Hierarchy - -- [`AddressPayload`](internal.AddressPayload.md) - - ↳ **`StorePostCustomersCustomerAddressesAddressReq`** - -## Properties - -### address\_1 - -• `Optional` **address\_1**: `string` - -#### Inherited from - -[AddressPayload](internal.AddressPayload.md).[address_1](internal.AddressPayload.md#address_1) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:160 - -___ - -### address\_2 - -• `Optional` **address\_2**: `string` - -#### Inherited from - -[AddressPayload](internal.AddressPayload.md).[address_2](internal.AddressPayload.md#address_2) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:161 - -___ - -### city - -• `Optional` **city**: `string` - -#### Inherited from - -[AddressPayload](internal.AddressPayload.md).[city](internal.AddressPayload.md#city) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:162 - -___ - -### company - -• `Optional` **company**: `string` - -#### Inherited from - -[AddressPayload](internal.AddressPayload.md).[company](internal.AddressPayload.md#company) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:159 - -___ - -### country\_code - -• `Optional` **country\_code**: `string` - -#### Inherited from - -[AddressPayload](internal.AddressPayload.md).[country_code](internal.AddressPayload.md#country_code) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:163 - -___ - -### first\_name - -• `Optional` **first\_name**: `string` - -#### Inherited from - -[AddressPayload](internal.AddressPayload.md).[first_name](internal.AddressPayload.md#first_name) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:155 - -___ - -### last\_name - -• `Optional` **last\_name**: `string` - -#### Inherited from - -[AddressPayload](internal.AddressPayload.md).[last_name](internal.AddressPayload.md#last_name) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:156 - -___ - -### metadata - -• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Inherited from - -[AddressPayload](internal.AddressPayload.md).[metadata](internal.AddressPayload.md#metadata) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:158 - -___ - -### phone - -• `Optional` **phone**: `string` - -#### Inherited from - -[AddressPayload](internal.AddressPayload.md).[phone](internal.AddressPayload.md#phone) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:157 - -___ - -### postal\_code - -• `Optional` **postal\_code**: `string` - -#### Inherited from - -[AddressPayload](internal.AddressPayload.md).[postal_code](internal.AddressPayload.md#postal_code) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:165 - -___ - -### province - -• `Optional` **province**: `string` - -#### Inherited from - -[AddressPayload](internal.AddressPayload.md).[province](internal.AddressPayload.md#province) - -#### Defined in - -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 deleted file mode 100644 index d7b3d7ef4d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostCustomersCustomerAddressesReq - -[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 - -• **address**: [`AddressCreatePayload`](internal.AddressCreatePayload.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/create-address.d.ts:92 diff --git a/www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx b/www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx new file mode 100644 index 0000000000..55ad447303 --- /dev/null +++ b/www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx @@ -0,0 +1,119 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CollectionsResource + +[collections](../../modules/collections.mdx).CollectionsResource + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCollectionsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a list of collections + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCollectionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a single collection diff --git a/www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx b/www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx new file mode 100644 index 0000000000..86d5c33ade --- /dev/null +++ b/www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx @@ -0,0 +1,332 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomerResource + +[customers](../../modules/customers.mdx).CustomerResource + +## Properties + + + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +Creates a customer + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCustomersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### generatePasswordToken + +▸ **generatePasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#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. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) + + + +___ + +### listOrders + +▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersListOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomerslistordersres)\> + +Retrieve customer orders + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersListOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomerslistordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCustomersListOrdersRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `orders`: [`Order`](../../internal/classes/admin_collections.internal.Order.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### resetPassword + +▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +Resets customer password + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCustomersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +Retrieves the customer that is currently logged + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCustomersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +Updates a customer + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCustomersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> 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 deleted file mode 100644 index 2f8f3d5443..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-1.UserRoles.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: UserRoles - -[internal](../modules/internal-1.md).UserRoles - -## Enumeration Members - -### ADMIN - -• **ADMIN** = ``"admin"`` - -#### Defined in - -packages/medusa/dist/models/user.d.ts:3 - -___ - -### DEVELOPER - -• **DEVELOPER** = ``"developer"`` - -#### Defined in - -packages/medusa/dist/models/user.d.ts:5 - -___ - -### MEMBER - -• **MEMBER** = ``"member"`` - -#### Defined in - -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 deleted file mode 100644 index a3151c11e1..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-2.BatchJobStatus.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: BatchJobStatus - -[internal](../modules/internal-2.md).BatchJobStatus - -## Enumeration Members - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -packages/medusa/dist/types/batch-job.d.ts:9 - -___ - -### COMPLETED - -• **COMPLETED** = ``"completed"`` - -#### Defined in - -packages/medusa/dist/types/batch-job.d.ts:8 - -___ - -### CONFIRMED - -• **CONFIRMED** = ``"confirmed"`` - -#### Defined in - -packages/medusa/dist/types/batch-job.d.ts:6 - -___ - -### CREATED - -• **CREATED** = ``"created"`` - -#### Defined in - -packages/medusa/dist/types/batch-job.d.ts:4 - -___ - -### FAILED - -• **FAILED** = ``"failed"`` - -#### Defined in - -packages/medusa/dist/types/batch-job.d.ts:10 - -___ - -### PRE\_PROCESSED - -• **PRE\_PROCESSED** = ``"pre_processed"`` - -#### Defined in - -packages/medusa/dist/types/batch-job.d.ts:5 - -___ - -### PROCESSING - -• **PROCESSING** = ``"processing"`` - -#### Defined in - -packages/medusa/dist/types/batch-job.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.AllocationType.md b/www/apps/docs/content/references/js-client/enums/internal-3.AllocationType.md deleted file mode 100644 index 4e80089ffd..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.AllocationType.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: AllocationType - -[internal](../modules/internal-3.md).AllocationType - -## Enumeration Members - -### ITEM - -• **ITEM** = ``"item"`` - -#### Defined in - -packages/medusa/dist/models/discount-rule.d.ts:10 - -___ - -### TOTAL - -• **TOTAL** = ``"total"`` - -#### Defined in - -packages/medusa/dist/models/discount-rule.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.CartType.md b/www/apps/docs/content/references/js-client/enums/internal-3.CartType.md deleted file mode 100644 index 5a3a224d00..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.CartType.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: CartType - -[internal](../modules/internal-3.md).CartType - -## Enumeration Members - -### CLAIM - -• **CLAIM** = ``"claim"`` - -#### Defined in - -packages/medusa/dist/models/cart.d.ts:248 - -___ - -### DEFAULT - -• **DEFAULT** = ``"default"`` - -#### Defined in - -packages/medusa/dist/models/cart.d.ts:244 - -___ - -### DRAFT\_ORDER - -• **DRAFT\_ORDER** = ``"draft_order"`` - -#### Defined in - -packages/medusa/dist/models/cart.d.ts:246 - -___ - -### PAYMENT\_LINK - -• **PAYMENT\_LINK** = ``"payment_link"`` - -#### Defined in - -packages/medusa/dist/models/cart.d.ts:247 - -___ - -### SWAP - -• **SWAP** = ``"swap"`` - -#### Defined in - -packages/medusa/dist/models/cart.d.ts:245 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.ClaimFulfillmentStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.ClaimFulfillmentStatus.md deleted file mode 100644 index cca7c0fa3f..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.ClaimFulfillmentStatus.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: ClaimFulfillmentStatus - -[internal](../modules/internal-3.md).ClaimFulfillmentStatus - -## Enumeration Members - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:26 - -___ - -### FULFILLED - -• **FULFILLED** = ``"fulfilled"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:21 - -___ - -### NOT\_FULFILLED - -• **NOT\_FULFILLED** = ``"not_fulfilled"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:19 - -___ - -### PARTIALLY\_FULFILLED - -• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:20 - -___ - -### PARTIALLY\_RETURNED - -• **PARTIALLY\_RETURNED** = ``"partially_returned"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:24 - -___ - -### PARTIALLY\_SHIPPED - -• **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:22 - -___ - -### REQUIRES\_ACTION - -• **REQUIRES\_ACTION** = ``"requires_action"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:27 - -___ - -### RETURNED - -• **RETURNED** = ``"returned"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:25 - -___ - -### SHIPPED - -• **SHIPPED** = ``"shipped"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:23 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.ClaimPaymentStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.ClaimPaymentStatus.md deleted file mode 100644 index 2b7ad93f24..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.ClaimPaymentStatus.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: ClaimPaymentStatus - -[internal](../modules/internal-3.md).ClaimPaymentStatus - -## Enumeration Members - -### NA - -• **NA** = ``"na"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:14 - -___ - -### NOT\_REFUNDED - -• **NOT\_REFUNDED** = ``"not_refunded"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:15 - -___ - -### REFUNDED - -• **REFUNDED** = ``"refunded"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:16 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.ClaimReason.md b/www/apps/docs/content/references/js-client/enums/internal-3.ClaimReason.md deleted file mode 100644 index 5cbaef6768..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.ClaimReason.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: ClaimReason - -[internal](../modules/internal-3.md).ClaimReason - -## Enumeration Members - -### MISSING\_ITEM - -• **MISSING\_ITEM** = ``"missing_item"`` - -#### Defined in - -packages/medusa/dist/models/claim-item.d.ts:8 - -___ - -### OTHER - -• **OTHER** = ``"other"`` - -#### Defined in - -packages/medusa/dist/models/claim-item.d.ts:11 - -___ - -### PRODUCTION\_FAILURE - -• **PRODUCTION\_FAILURE** = ``"production_failure"`` - -#### Defined in - -packages/medusa/dist/models/claim-item.d.ts:10 - -___ - -### WRONG\_ITEM - -• **WRONG\_ITEM** = ``"wrong_item"`` - -#### Defined in - -packages/medusa/dist/models/claim-item.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.ClaimType.md b/www/apps/docs/content/references/js-client/enums/internal-3.ClaimType.md deleted file mode 100644 index 818b664463..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.ClaimType.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: ClaimType - -[internal](../modules/internal-3.md).ClaimType - -## Enumeration Members - -### REFUND - -• **REFUND** = ``"refund"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:10 - -___ - -### REPLACE - -• **REPLACE** = ``"replace"`` - -#### Defined in - -packages/medusa/dist/models/claim-order.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionOperator.md b/www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionOperator.md deleted file mode 100644 index 22ea480005..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionOperator.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: DiscountConditionOperator - -[internal](../modules/internal-3.md).DiscountConditionOperator - -## Enumeration Members - -### IN - -• **IN** = ``"in"`` - -#### Defined in - -packages/medusa/dist/models/discount-condition.d.ts:16 - -___ - -### NOT\_IN - -• **NOT\_IN** = ``"not_in"`` - -#### Defined in - -packages/medusa/dist/models/discount-condition.d.ts:17 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionType.md b/www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionType.md deleted file mode 100644 index cf9ea06796..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionType.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: DiscountConditionType - -[internal](../modules/internal-3.md).DiscountConditionType - -## Enumeration Members - -### CUSTOMER\_GROUPS - -• **CUSTOMER\_GROUPS** = ``"customer_groups"`` - -#### Defined in - -packages/medusa/dist/models/discount-condition.d.ts:13 - -___ - -### PRODUCTS - -• **PRODUCTS** = ``"products"`` - -#### Defined in - -packages/medusa/dist/models/discount-condition.d.ts:9 - -___ - -### PRODUCT\_COLLECTIONS - -• **PRODUCT\_COLLECTIONS** = ``"product_collections"`` - -#### Defined in - -packages/medusa/dist/models/discount-condition.d.ts:11 - -___ - -### PRODUCT\_TAGS - -• **PRODUCT\_TAGS** = ``"product_tags"`` - -#### Defined in - -packages/medusa/dist/models/discount-condition.d.ts:12 - -___ - -### PRODUCT\_TYPES - -• **PRODUCT\_TYPES** = ``"product_types"`` - -#### Defined in - -packages/medusa/dist/models/discount-condition.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.DiscountRuleType.md b/www/apps/docs/content/references/js-client/enums/internal-3.DiscountRuleType.md deleted file mode 100644 index c2d37c3c4e..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.DiscountRuleType.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: DiscountRuleType - -[internal](../modules/internal-3.md).DiscountRuleType - -## Enumeration Members - -### FIXED - -• **FIXED** = ``"fixed"`` - -#### Defined in - -packages/medusa/dist/models/discount-rule.d.ts:4 - -___ - -### FREE\_SHIPPING - -• **FREE\_SHIPPING** = ``"free_shipping"`` - -#### Defined in - -packages/medusa/dist/models/discount-rule.d.ts:6 - -___ - -### PERCENTAGE - -• **PERCENTAGE** = ``"percentage"`` - -#### Defined in - -packages/medusa/dist/models/discount-rule.d.ts:5 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.DraftOrderStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.DraftOrderStatus.md deleted file mode 100644 index 3a1d7ce69d..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.DraftOrderStatus.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: DraftOrderStatus - -[internal](../modules/internal-3.md).DraftOrderStatus - -## Enumeration Members - -### COMPLETED - -• **COMPLETED** = ``"completed"`` - -#### Defined in - -packages/medusa/dist/models/draft-order.d.ts:6 - -___ - -### OPEN - -• **OPEN** = ``"open"`` - -#### Defined in - -packages/medusa/dist/models/draft-order.d.ts:5 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.OrderEditItemChangeType.md b/www/apps/docs/content/references/js-client/enums/internal-3.OrderEditItemChangeType.md deleted file mode 100644 index 7da0646bbf..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.OrderEditItemChangeType.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: OrderEditItemChangeType - -[internal](../modules/internal-3.md).OrderEditItemChangeType - -## Enumeration Members - -### ITEM\_ADD - -• **ITEM\_ADD** = ``"item_add"`` - -#### Defined in - -packages/medusa/dist/models/order-item-change.d.ts:5 - -___ - -### ITEM\_REMOVE - -• **ITEM\_REMOVE** = ``"item_remove"`` - -#### Defined in - -packages/medusa/dist/models/order-item-change.d.ts:6 - -___ - -### ITEM\_UPDATE - -• **ITEM\_UPDATE** = ``"item_update"`` - -#### Defined in - -packages/medusa/dist/models/order-item-change.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.OrderEditStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.OrderEditStatus.md deleted file mode 100644 index fae1b0303b..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.OrderEditStatus.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: OrderEditStatus - -[internal](../modules/internal-3.md).OrderEditStatus - -## Enumeration Members - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:8 - -___ - -### CONFIRMED - -• **CONFIRMED** = ``"confirmed"`` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:4 - -___ - -### CREATED - -• **CREATED** = ``"created"`` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:7 - -___ - -### DECLINED - -• **DECLINED** = ``"declined"`` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:5 - -___ - -### REQUESTED - -• **REQUESTED** = ``"requested"`` - -#### Defined in - -packages/medusa/dist/models/order-edit.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.OrderStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.OrderStatus.md deleted file mode 100644 index a4ebdff77c..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.OrderStatus.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: OrderStatus - -[internal](../modules/internal-3.md).OrderStatus - -## Enumeration Members - -### ARCHIVED - -• **ARCHIVED** = ``"archived"`` - -#### Defined in - -packages/medusa/dist/models/order.d.ts:24 - -___ - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -packages/medusa/dist/models/order.d.ts:25 - -___ - -### COMPLETED - -• **COMPLETED** = ``"completed"`` - -#### Defined in - -packages/medusa/dist/models/order.d.ts:23 - -___ - -### PENDING - -• **PENDING** = ``"pending"`` - -#### Defined in - -packages/medusa/dist/models/order.d.ts:22 - -___ - -### REQUIRES\_ACTION - -• **REQUIRES\_ACTION** = ``"requires_action"`` - -#### Defined in - -packages/medusa/dist/models/order.d.ts:26 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.PaymentCollectionStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.PaymentCollectionStatus.md deleted file mode 100644 index 25a34d6b0d..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.PaymentCollectionStatus.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: PaymentCollectionStatus - -[internal](../modules/internal-3.md).PaymentCollectionStatus - -## Enumeration Members - -### AUTHORIZED - -• **AUTHORIZED** = ``"authorized"`` - -#### Defined in - -packages/medusa/dist/models/payment-collection.d.ts:6 - -___ - -### AWAITING - -• **AWAITING** = ``"awaiting"`` - -#### Defined in - -packages/medusa/dist/models/payment-collection.d.ts:5 - -___ - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -packages/medusa/dist/models/payment-collection.d.ts:8 - -___ - -### NOT\_PAID - -• **NOT\_PAID** = ``"not_paid"`` - -#### Defined in - -packages/medusa/dist/models/payment-collection.d.ts:4 - -___ - -### PARTIALLY\_AUTHORIZED - -• **PARTIALLY\_AUTHORIZED** = ``"partially_authorized"`` - -#### Defined in - -packages/medusa/dist/models/payment-collection.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.PriceListStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.PriceListStatus.md deleted file mode 100644 index 7579a9c490..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.PriceListStatus.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: PriceListStatus - -[internal](../modules/internal-3.md).PriceListStatus - -## Enumeration Members - -### ACTIVE - -• **ACTIVE** = ``"active"`` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:8 - -___ - -### DRAFT - -• **DRAFT** = ``"draft"`` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.PriceListType.md b/www/apps/docs/content/references/js-client/enums/internal-3.PriceListType.md deleted file mode 100644 index d530bb75bf..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.PriceListType.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: PriceListType - -[internal](../modules/internal-3.md).PriceListType - -## Enumeration Members - -### OVERRIDE - -• **OVERRIDE** = ``"override"`` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:5 - -___ - -### SALE - -• **SALE** = ``"sale"`` - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.ProductStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.ProductStatus.md deleted file mode 100644 index 175c2ff076..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.ProductStatus.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: ProductStatus - -[internal](../modules/internal-3.md).ProductStatus - -## Enumeration Members - -### DRAFT - -• **DRAFT** = ``"draft"`` - -#### Defined in - -packages/medusa/dist/models/product.d.ts:12 - -___ - -### PROPOSED - -• **PROPOSED** = ``"proposed"`` - -#### Defined in - -packages/medusa/dist/models/product.d.ts:13 - -___ - -### PUBLISHED - -• **PUBLISHED** = ``"published"`` - -#### Defined in - -packages/medusa/dist/models/product.d.ts:14 - -___ - -### REJECTED - -• **REJECTED** = ``"rejected"`` - -#### Defined in - -packages/medusa/dist/models/product.d.ts:15 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.RequirementType.md b/www/apps/docs/content/references/js-client/enums/internal-3.RequirementType.md deleted file mode 100644 index 16995f5310..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.RequirementType.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: RequirementType - -[internal](../modules/internal-3.md).RequirementType - -## Enumeration Members - -### MAX\_SUBTOTAL - -• **MAX\_SUBTOTAL** = ``"max_subtotal"`` - -#### Defined in - -packages/medusa/dist/models/shipping-option-requirement.d.ts:4 - -___ - -### MIN\_SUBTOTAL - -• **MIN\_SUBTOTAL** = ``"min_subtotal"`` - -#### Defined in - -packages/medusa/dist/models/shipping-option-requirement.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.ReturnStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.ReturnStatus.md deleted file mode 100644 index 1cfef96dfd..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.ReturnStatus.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: ReturnStatus - -[internal](../modules/internal-3.md).ReturnStatus - -## Enumeration Members - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -packages/medusa/dist/models/return.d.ts:11 - -___ - -### RECEIVED - -• **RECEIVED** = ``"received"`` - -#### Defined in - -packages/medusa/dist/models/return.d.ts:9 - -___ - -### REQUESTED - -• **REQUESTED** = ``"requested"`` - -#### Defined in - -packages/medusa/dist/models/return.d.ts:8 - -___ - -### REQUIRES\_ACTION - -• **REQUIRES\_ACTION** = ``"requires_action"`` - -#### Defined in - -packages/medusa/dist/models/return.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.ShippingOptionPriceType.md b/www/apps/docs/content/references/js-client/enums/internal-3.ShippingOptionPriceType.md deleted file mode 100644 index 4d24f57447..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.ShippingOptionPriceType.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: ShippingOptionPriceType - -[internal](../modules/internal-3.md).ShippingOptionPriceType - -## Enumeration Members - -### CALCULATED - -• **CALCULATED** = ``"calculated"`` - -#### Defined in - -packages/medusa/dist/models/shipping-option.d.ts:8 - -___ - -### FLAT\_RATE - -• **FLAT\_RATE** = ``"flat_rate"`` - -#### Defined in - -packages/medusa/dist/models/shipping-option.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.ShippingProfileType.md b/www/apps/docs/content/references/js-client/enums/internal-3.ShippingProfileType.md deleted file mode 100644 index 2ef2ae7e7c..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-3.ShippingProfileType.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: ShippingProfileType - -[internal](../modules/internal-3.md).ShippingProfileType - -## Enumeration Members - -### CUSTOM - -• **CUSTOM** = ``"custom"`` - -#### Defined in - -packages/medusa/dist/models/shipping-profile.d.ts:7 - -___ - -### DEFAULT - -• **DEFAULT** = ``"default"`` - -#### Defined in - -packages/medusa/dist/models/shipping-profile.d.ts:5 - -___ - -### GIFT\_CARD - -• **GIFT\_CARD** = ``"gift_card"`` - -#### Defined in - -packages/medusa/dist/models/shipping-profile.d.ts:6 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 deleted file mode 100644 index b0243f88d6..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-8.DefaultPriceType.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -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 deleted file mode 100644 index c55e311c32..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-8.DiscountConditionJoinTableForeignKey.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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.MODULE_RESOURCE_TYPE.md b/www/apps/docs/content/references/js-client/enums/internal-8.MODULE_RESOURCE_TYPE.md deleted file mode 100644 index 514cc1c9bd..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-8.MODULE_RESOURCE_TYPE.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 95f9c8e530..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-8.OrderStatus.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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.internal.PaymentCollectionType.md b/www/apps/docs/content/references/js-client/enums/internal-8.internal.PaymentCollectionType.md deleted file mode 100644 index a081f71987..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-8.internal.PaymentCollectionType.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -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 deleted file mode 100644 index 5dd60497fc..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-8.internal.PaymentSessionStatus.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index 3ca1ccb7ae..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-8.internal.PostgresError.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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-8.internal.RefundReason.md b/www/apps/docs/content/references/js-client/enums/internal-8.internal.RefundReason.md deleted file mode 100644 index 5541e49d22..0000000000 --- a/www/apps/docs/content/references/js-client/enums/internal-8.internal.RefundReason.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: RefundReason - -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).RefundReason - -## Enumeration Members - -### CLAIM - -• **CLAIM** = ``"claim"`` - -#### Defined in - -packages/medusa/dist/models/refund.d.ts:8 - -___ - -### DISCOUNT - -• **DISCOUNT** = ``"discount"`` - -#### Defined in - -packages/medusa/dist/models/refund.d.ts:5 - -___ - -### OTHER - -• **OTHER** = ``"other"`` - -#### Defined in - -packages/medusa/dist/models/refund.d.ts:9 - -___ - -### RETURN - -• **RETURN** = ``"return"`` - -#### Defined in - -packages/medusa/dist/models/refund.d.ts:6 - -___ - -### SWAP - -• **SWAP** = ``"swap"`` - -#### Defined in - -packages/medusa/dist/models/refund.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx b/www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx new file mode 100644 index 0000000000..c556ea45ef --- /dev/null +++ b/www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx @@ -0,0 +1,64 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# GiftCardsResource + +[gift-cards](../../modules/gift_cards.mdx).GiftCardsResource + +## Methods + +### retrieve + +▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegiftcardsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegiftcardsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreGiftCardsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a single GiftCard diff --git a/www/apps/docs/content/references/js-client/index.md b/www/apps/docs/content/references/js-client/index.md index 56cf3544ed..a649216f33 100644 --- a/www/apps/docs/content/references/js-client/index.md +++ b/www/apps/docs/content/references/js-client/index.md @@ -2,83 +2,70 @@ displayed_sidebar: jsClientSidebar --- +import ParameterTypes from "@site/src/components/ParameterTypes" + # JS Client Reference ## Modules -- [internal](modules/internal.md) -- [internal](modules/internal-1.md) -- [internal](modules/internal-2.md) -- [internal](modules/internal-3.md) -- [internal](modules/internal-4.md) -- [internal](modules/internal-5.md) -- [internal](modules/internal-6.md) -- [internal](modules/internal-7.md) -- [internal](modules/internal-8.md) -- [internal](modules/internal-9.md) -- [internal](modules/internal-10.md) -- [internal](modules/internal-11.md) -- [internal](modules/internal-12.md) - -## Classes - -- [AddressesResource](classes/AddressesResource.md) -- [Admin](classes/Admin.md) -- [AdminAuthResource](classes/AdminAuthResource.md) -- [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) -- [AdminOrderEditsResource](classes/AdminOrderEditsResource.md) -- [AdminOrdersResource](classes/AdminOrdersResource.md) -- [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) -- [AdminUploadsResource](classes/AdminUploadsResource.md) -- [AdminUsersResource](classes/AdminUsersResource.md) -- [AdminVariantsResource](classes/AdminVariantsResource.md) -- [AuthResource](classes/AuthResource.md) -- [CartsResource](classes/CartsResource.md) -- [CollectionsResource](classes/CollectionsResource.md) -- [CustomerResource](classes/CustomerResource.md) -- [GiftCardsResource](classes/GiftCardsResource.md) -- [LineItemsResource](classes/LineItemsResource.md) -- [OrderEditsResource](classes/OrderEditsResource.md) -- [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) -- [RegionsResource](classes/RegionsResource.md) -- [ReturnReasonsResource](classes/ReturnReasonsResource.md) -- [ReturnsResource](classes/ReturnsResource.md) -- [ShippingOptionsResource](classes/ShippingOptionsResource.md) -- [SwapsResource](classes/SwapsResource.md) +- [addresses](modules/addresses.mdx) +- [admin](modules/admin.mdx) +- [admin/auth](modules/admin_auth.mdx) +- [admin/batch-jobs](modules/admin_batch_jobs.mdx) +- [admin/collections](modules/admin_collections.mdx) +- [admin/currencies](modules/admin_currencies.mdx) +- [admin/custom](modules/admin_custom.mdx) +- [admin/customer-groups](modules/admin_customer_groups.mdx) +- [admin/customers](modules/admin_customers.mdx) +- [admin/discounts](modules/admin_discounts.mdx) +- [admin/draft-orders](modules/admin_draft_orders.mdx) +- [admin/gift-cards](modules/admin_gift_cards.mdx) +- [admin/inventory-item](modules/admin_inventory_item.mdx) +- [admin/invites](modules/admin_invites.mdx) +- [admin/notes](modules/admin_notes.mdx) +- [admin/notifications](modules/admin_notifications.mdx) +- [admin/order-edits](modules/admin_order_edits.mdx) +- [admin/orders](modules/admin_orders.mdx) +- [admin/payment-collections](modules/admin_payment_collections.mdx) +- [admin/payments](modules/admin_payments.mdx) +- [admin/price-lists](modules/admin_price_lists.mdx) +- [admin/product-categories](modules/admin_product_categories.mdx) +- [admin/product-tags](modules/admin_product_tags.mdx) +- [admin/product-types](modules/admin_product_types.mdx) +- [admin/products](modules/admin_products.mdx) +- [admin/publishable-api-keys](modules/admin_publishable_api_keys.mdx) +- [admin/regions](modules/admin_regions.mdx) +- [admin/reservations](modules/admin_reservations.mdx) +- [admin/return-reasons](modules/admin_return_reasons.mdx) +- [admin/returns](modules/admin_returns.mdx) +- [admin/sales-channels](modules/admin_sales_channels.mdx) +- [admin/shipping-options](modules/admin_shipping_options.mdx) +- [admin/shipping-profiles](modules/admin_shipping_profiles.mdx) +- [admin/stock-locations](modules/admin_stock_locations.mdx) +- [admin/store](modules/admin_store.mdx) +- [admin/swaps](modules/admin_swaps.mdx) +- [admin/tax-rates](modules/admin_tax_rates.mdx) +- [admin/uploads](modules/admin_uploads.mdx) +- [admin/users](modules/admin_users.mdx) +- [admin/variants](modules/admin_variants.mdx) +- [auth](modules/auth.mdx) +- [carts](modules/carts.mdx) +- [collections](modules/collections.mdx) +- [customers](modules/customers.mdx) +- [gift-cards](modules/gift_cards.mdx) +- [index](modules/index.mdx) +- [line-items](modules/line_items.mdx) +- [order-edits](modules/order_edits.mdx) +- [orders](modules/orders.mdx) +- [payment-collections](modules/payment_collections.mdx) +- [payment-methods](modules/payment_methods.mdx) +- [product-categories](modules/product_categories.mdx) +- [product-tags](modules/product_tags.mdx) +- [product-types](modules/product_types.mdx) +- [product-variants](modules/product_variants.mdx) +- [products](modules/products.mdx) +- [regions](modules/regions.mdx) +- [return-reasons](modules/return_reasons.mdx) +- [returns](modules/returns.mdx) +- [shipping-options](modules/shipping_options.mdx) +- [swaps](modules/swaps.mdx) 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 deleted file mode 100644 index 9865c1dfe2..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.BlobPropertyBag.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index d642be5d89..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.File.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -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 deleted file mode 100644 index e6b370ed1a..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.FilePropertyBag.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -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 deleted file mode 100644 index 53c90619ca..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.QueuingStrategy.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index 7892c1a3d2..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.QueuingStrategySize.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index bd86c62e76..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableByteStreamController.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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 deleted file mode 100644 index c1e2df47a4..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStream.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -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 deleted file mode 100644 index d328032879..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamBYOBReader.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -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 deleted file mode 100644 index 6cc7c62681..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamBYOBRequest.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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 deleted file mode 100644 index 39600488b4..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamDefaultController.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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 deleted file mode 100644 index f84b79a06d..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamDefaultReader.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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 deleted file mode 100644 index b0d3a6ce34..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamGenericReader.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 deleted file mode 100644 index 2254db6dd3..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamGetReaderOptions.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -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 deleted file mode 100644 index ca59614596..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamReadDoneResult.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index 39c8c920e6..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamReadValueResult.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index 3e07994968..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableWritablePair.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -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 deleted file mode 100644 index 36c69fdaf7..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.StreamPipeOptions.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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 deleted file mode 100644 index ce66e4df88..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingByteSource.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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 deleted file mode 100644 index 56843fcd16..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingDefaultSource.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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 deleted file mode 100644 index f243ae6bf8..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSink.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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 deleted file mode 100644 index e840f0b2ce..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkAbortCallback.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index e11fd5b40c..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkCloseCallback.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -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 deleted file mode 100644 index 34e4d14bfd..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkStartCallback.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index fb3be1f057..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkWriteCallback.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -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 deleted file mode 100644 index e047ece30f..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSource.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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 deleted file mode 100644 index b6ec279c67..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourceCancelCallback.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 47c060c20b..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourcePullCallback.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index 4f6467106e..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourceStartCallback.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index 75a8b273ab..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStream.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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 deleted file mode 100644 index 2d9f329a3d..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStreamDefaultController.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index dc9aec6505..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStreamDefaultWriter.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -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 deleted file mode 100644 index 1b98da8347..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosAdapter.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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-12.AxiosBasicCredentials.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosBasicCredentials.md deleted file mode 100644 index 39307fc479..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosBasicCredentials.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: AxiosBasicCredentials - -[internal](../modules/internal-12.md).AxiosBasicCredentials - -## Properties - -### password - -• **password**: `string` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:23 - -___ - -### username - -• **username**: `string` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:22 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosDefaults.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosDefaults.md deleted file mode 100644 index 69e00b1bbe..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosDefaults.md +++ /dev/null @@ -1,521 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: AxiosDefaults - -[internal](../modules/internal-12.md).AxiosDefaults - -Construct a type with the properties of T except for those in type K. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `D` | `any` | - -## Hierarchy - -- [`Omit`](../modules/internal-1.md#omit)<`AxiosRequestConfig`<`D`\>, ``"headers"``\> - - ↳ **`AxiosDefaults`** - -## Properties - -### adapter - -• `Optional` **adapter**: [`AxiosAdapter`](internal-12.AxiosAdapter.md) - -#### Inherited from - -Omit.adapter - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:75 - -___ - -### auth - -• `Optional` **auth**: [`AxiosBasicCredentials`](internal-12.AxiosBasicCredentials.md) - -#### Inherited from - -Omit.auth - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:76 - -___ - -### baseURL - -• `Optional` **baseURL**: `string` - -#### Inherited from - -Omit.baseURL - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:65 - -___ - -### cancelToken - -• `Optional` **cancelToken**: [`CancelToken`](internal-12.CancelToken.md) - -#### Inherited from - -Omit.cancelToken - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:90 - -___ - -### data - -• `Optional` **data**: `D` - -#### Inherited from - -Omit.data - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:71 - -___ - -### decompress - -• `Optional` **decompress**: `boolean` - -#### Inherited from - -Omit.decompress - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:91 - -___ - -### headers - -• **headers**: [`HeadersDefaults`](internal-12.HeadersDefaults.md) - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:112 - -___ - -### httpAgent - -• `Optional` **httpAgent**: `any` - -#### Inherited from - -Omit.httpAgent - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:87 - -___ - -### httpsAgent - -• `Optional` **httpsAgent**: `any` - -#### Inherited from - -Omit.httpsAgent - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:88 - -___ - -### insecureHTTPParser - -• `Optional` **insecureHTTPParser**: `boolean` - -#### Inherited from - -Omit.insecureHTTPParser - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:94 - -___ - -### maxBodyLength - -• `Optional` **maxBodyLength**: `number` - -#### Inherited from - -Omit.maxBodyLength - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:84 - -___ - -### maxContentLength - -• `Optional` **maxContentLength**: `number` - -#### Inherited from - -Omit.maxContentLength - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:82 - -___ - -### maxRedirects - -• `Optional` **maxRedirects**: `number` - -#### Inherited from - -Omit.maxRedirects - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:85 - -___ - -### method - -• `Optional` **method**: [`Method`](../modules/internal-12.md#method) - -#### Inherited from - -Omit.method - -#### Defined in - -packages/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` - -#### Inherited from - -Omit.onDownloadProgress - -#### Defined in - -packages/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` - -#### Inherited from - -Omit.onUploadProgress - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:80 - -___ - -### params - -• `Optional` **params**: `any` - -#### Inherited from - -Omit.params - -#### Defined in - -packages/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` - -#### Inherited from - -Omit.paramsSerializer - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:70 - -___ - -### proxy - -• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](internal-12.AxiosProxyConfig.md) - -#### Inherited from - -Omit.proxy - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:89 - -___ - -### raxConfig - -• `Optional` **raxConfig**: [`RetryConfig`](internal-12.RetryConfig.md) - -#### Inherited from - -Omit.raxConfig - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89 - -___ - -### responseType - -• `Optional` **responseType**: [`ResponseType`](../modules/internal-12.md#responsetype) - -#### Inherited from - -Omit.responseType - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:77 - -___ - -### signal - -• `Optional` **signal**: `AbortSignal` - -#### Inherited from - -Omit.signal - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:93 - -___ - -### socketPath - -• `Optional` **socketPath**: ``null`` \| `string` - -#### Inherited from - -Omit.socketPath - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:86 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Inherited from - -Omit.timeout - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:72 - -___ - -### timeoutErrorMessage - -• `Optional` **timeoutErrorMessage**: `string` - -#### Inherited from - -Omit.timeoutErrorMessage - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:73 - -___ - -### transformRequest - -• `Optional` **transformRequest**: [`AxiosRequestTransformer`](internal-12.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](internal-12.AxiosRequestTransformer.md)[] - -#### Inherited from - -Omit.transformRequest - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:66 - -___ - -### transformResponse - -• `Optional` **transformResponse**: [`AxiosResponseTransformer`](internal-12.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](internal-12.AxiosResponseTransformer.md)[] - -#### Inherited from - -Omit.transformResponse - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:67 - -___ - -### transitional - -• `Optional` **transitional**: [`TransitionalOptions`](internal-12.TransitionalOptions.md) - -#### Inherited from - -Omit.transitional - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:92 - -___ - -### url - -• `Optional` **url**: `string` - -#### Inherited from - -Omit.url - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:63 - -___ - -### validateStatus - -• `Optional` **validateStatus**: ``null`` \| (`status`: `number`) => `boolean` - -#### Inherited from - -Omit.validateStatus - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:83 - -___ - -### withCredentials - -• `Optional` **withCredentials**: `boolean` - -#### Inherited from - -Omit.withCredentials - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:74 - -___ - -### xsrfCookieName - -• `Optional` **xsrfCookieName**: `string` - -#### Inherited from - -Omit.xsrfCookieName - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:78 - -___ - -### xsrfHeaderName - -• `Optional` **xsrfHeaderName**: `string` - -#### Inherited from - -Omit.xsrfHeaderName - -#### Defined in - -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 deleted file mode 100644 index fad7c65a13..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosError.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -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 deleted file mode 100644 index b28d4d04c2..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosInstance.md +++ /dev/null @@ -1,377 +0,0 @@ ---- -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-12.AxiosInterceptorManager.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosInterceptorManager.md deleted file mode 100644 index 569b8ffe78..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosInterceptorManager.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: AxiosInterceptorManager - -[internal](../modules/internal-12.md).AxiosInterceptorManager - -## Type parameters - -| Name | -| :------ | -| `V` | - -## Methods - -### eject - -▸ **eject**(`id`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `number` | - -#### Returns - -`void` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:166 - -___ - -### use - -▸ **use**<`T`\>(`onFulfilled?`, `onRejected?`): `number` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `V` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onFulfilled?` | (`value`: `V`) => `T` \| `Promise`<`T`\> | -| `onRejected?` | (`error`: `any`) => `any` | - -#### Returns - -`number` - -#### Defined in - -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 deleted file mode 100644 index db57800135..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosPromise.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -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-12.AxiosProxyConfig.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosProxyConfig.md deleted file mode 100644 index 2ceb1e37bd..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosProxyConfig.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: AxiosProxyConfig - -[internal](../modules/internal-12.md).AxiosProxyConfig - -## Properties - -### auth - -• `Optional` **auth**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `password` | `string` | -| `username` | `string` | - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:29 - -___ - -### host - -• **host**: `string` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:27 - -___ - -### port - -• **port**: `number` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:28 - -___ - -### protocol - -• `Optional` **protocol**: `string` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:33 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosRequestTransformer.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosRequestTransformer.md deleted file mode 100644 index 43dcdd350f..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosRequestTransformer.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: AxiosRequestTransformer - -[internal](../modules/internal-12.md).AxiosRequestTransformer - -## Callable - -### AxiosRequestTransformer - -▸ **AxiosRequestTransformer**(`data`, `headers?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `headers?` | [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) | - -#### Returns - -`any` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponse.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponse.md deleted file mode 100644 index 090e4a4d91..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponse.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: AxiosResponse - -[internal](../modules/internal-12.md).AxiosResponse - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `D` | `any` | - -## Properties - -### config - -• **config**: `AxiosRequestConfig`<`D`\> - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:120 - -___ - -### data - -• **data**: `T` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:116 - -___ - -### headers - -• **headers**: [`AxiosResponseHeaders`](../modules/internal-12.md#axiosresponseheaders) - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:119 - -___ - -### request - -• `Optional` **request**: `any` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:121 - -___ - -### status - -• **status**: `number` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:117 - -___ - -### statusText - -• **statusText**: `string` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:118 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponseTransformer.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponseTransformer.md deleted file mode 100644 index bb811e97b3..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponseTransformer.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: AxiosResponseTransformer - -[internal](../modules/internal-12.md).AxiosResponseTransformer - -## Callable - -### AxiosResponseTransformer - -▸ **AxiosResponseTransformer**(`data`, `headers?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `any` | -| `headers?` | [`AxiosResponseHeaders`](../modules/internal-12.md#axiosresponseheaders) | - -#### Returns - -`any` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:14 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-12.Cancel.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.Cancel.md deleted file mode 100644 index 29e9413eb0..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.Cancel.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: Cancel - -[internal](../modules/internal-12.md).Cancel - -## Properties - -### message - -• **message**: `string` - -#### Defined in - -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 deleted file mode 100644 index 3bd946ff9e..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.CancelToken.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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 deleted file mode 100644 index afde80977c..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.Config.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index 9e6c2f05d0..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.HTTPResponse.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index 8a30be6231..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.HeadersDefaults.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -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-12.RetryConfig.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.RetryConfig.md deleted file mode 100644 index 717868ff27..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.RetryConfig.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: RetryConfig - -[internal](../modules/internal-12.md).RetryConfig - -Configuration for the Axios `request` method. - -## Properties - -### backoffType - -• `Optional` **backoffType**: ``"linear"`` \| ``"static"`` \| ``"exponential"`` - -Backoff Type; 'linear', 'static' or 'exponential'. - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:47 - -___ - -### checkRetryAfter - -• `Optional` **checkRetryAfter**: `boolean` - -Whether to check for 'Retry-After' header in response and use value as delay. Defaults to true. - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:51 - -___ - -### currentRetryAttempt - -• `Optional` **currentRetryAttempt**: `number` - -The number of retries already attempted. - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:13 - -___ - -### httpMethodsToRetry - -• `Optional` **httpMethodsToRetry**: `string`[] - -The HTTP Methods that will be automatically retried. -Defaults to ['GET','PUT','HEAD','OPTIONS','DELETE'] - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:26 - -___ - -### instance - -• `Optional` **instance**: [`AxiosInstance`](internal-12.AxiosInstance.md) - -The instance of the axios object to which the interceptor is attached. - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:21 - -___ - -### maxRetryAfter - -• `Optional` **maxRetryAfter**: `number` - -Max permitted Retry-After value (in ms) - rejects if greater. Defaults to 5 mins. - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:55 - -___ - -### maxRetryDelay - -• `Optional` **maxRetryDelay**: `number` - -Ceiling for calculated delay (in ms) - delay will not exceed this value. - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:59 - -___ - -### noResponseRetries - -• `Optional` **noResponseRetries**: `number` - -When there is no response, the number of retries to attempt. Defaults to 2. - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:43 - -___ - -### onRetryAttempt - -• `Optional` **onRetryAttempt**: (`err`: [`AxiosError`](internal-12.AxiosError.md)<`any`, `any`\>) => `void` - -#### Type declaration - -▸ (`err`): `void` - -Function to invoke when a retry attempt is made. - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | [`AxiosError`](internal-12.AxiosError.md)<`any`, `any`\> | - -##### Returns - -`void` - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:35 - -___ - -### retry - -• `Optional` **retry**: `number` - -The number of times to retry the request. Defaults to 3. - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:9 - -___ - -### retryDelay - -• `Optional` **retryDelay**: `number` - -The amount of time to initially delay the retry. Defaults to 100. - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:17 - -___ - -### shouldRetry - -• `Optional` **shouldRetry**: (`err`: [`AxiosError`](internal-12.AxiosError.md)<`any`, `any`\>) => `boolean` - -#### Type declaration - -▸ (`err`): `boolean` - -Function to invoke which determines if you should retry - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | [`AxiosError`](internal-12.AxiosError.md)<`any`, `any`\> | - -##### Returns - -`boolean` - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:39 - -___ - -### statusCodesToRetry - -• `Optional` **statusCodesToRetry**: `number`[][] - -The HTTP response status codes that will automatically be retried. -Defaults to: [[100, 199], [429, 429], [500, 599]] - -#### Defined in - -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-12.TransitionalOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.TransitionalOptions.md deleted file mode 100644 index 5226b997aa..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-12.TransitionalOptions.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: TransitionalOptions - -[internal](../modules/internal-12.md).TransitionalOptions - -## Properties - -### clarifyTimeoutError - -• `Optional` **clarifyTimeoutError**: `boolean` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:59 - -___ - -### forcedJSONParsing - -• `Optional` **forcedJSONParsing**: `boolean` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:58 - -___ - -### silentJSONParsing - -• `Optional` **silentJSONParsing**: `boolean` - -#### Defined in - -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 deleted file mode 100644 index c0edb89380..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-3.Boolean.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -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 deleted file mode 100644 index 042202fdd9..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-5.RequestOptions.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index f165e575df..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ArrayBufferView.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index edd3d60f3d..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ArrayLike.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index be5d6f5bd4..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncGenerator.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -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 deleted file mode 100644 index 208e6a3399..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncGeneratorFunction.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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 deleted file mode 100644 index 10c6d9b1ce..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterable.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index dc8fc078cf..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterableIterator.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -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 deleted file mode 100644 index 07fa23e8e8..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterator.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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 deleted file mode 100644 index e9b273fd21..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.BlobOptions.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 deleted file mode 100644 index 3fa9e8240d..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.Buffer.md +++ /dev/null @@ -1,4086 +0,0 @@ ---- -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 deleted file mode 100644 index a12f768b20..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.BufferConstructor.md +++ /dev/null @@ -1,606 +0,0 @@ ---- -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 deleted file mode 100644 index af4745d732..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.CallSite.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -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 deleted file mode 100644 index a2b704ae77..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.CreateNoteInput.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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 deleted file mode 100644 index 496ef9dce6..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.CreateUserInput.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index 2ea178543b..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.DuplexOptions.md +++ /dev/null @@ -1,345 +0,0 @@ ---- -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 deleted file mode 100644 index 935a30eb8f..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ErrnoException.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -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 deleted file mode 100644 index 0868cea02d..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.Error.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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.Abortable.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter.Abortable.md deleted file mode 100644 index dbef089527..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter.Abortable.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 409299f482..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitterOptions.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -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 deleted file mode 100644 index ce259476f6..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.FindConfig.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -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 deleted file mode 100644 index 956870bbb3..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ICacheService.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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 deleted file mode 100644 index 0deedbbe70..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.IEventBusModuleService.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -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 deleted file mode 100644 index 34c3cac667..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.IEventBusService.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -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 deleted file mode 100644 index 97e3d7f7a5..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.IFlagRouter.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -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 deleted file mode 100644 index 780f02b21c..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.IInventoryService.md +++ /dev/null @@ -1,605 +0,0 @@ ---- -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 deleted file mode 100644 index a9f6c84a7c..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ISearchService.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -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 deleted file mode 100644 index ea146ce837..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.IStockLocationService.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -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 deleted file mode 100644 index c264e85d98..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ITransactionBaseService.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -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 deleted file mode 100644 index a2c3adea0c..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.Iterable.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 7699ddc8f1..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.IterableIterator.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -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 deleted file mode 100644 index ad0a9a41e0..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.Iterator.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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 deleted file mode 100644 index 93f46022b7..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.IteratorReturnResult.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index 7109db3956..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.IteratorYieldResult.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index 4f0ababf4d..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.JoinerServiceConfig.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -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 deleted file mode 100644 index 143e43e5f5..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.JoinerServiceConfigAlias.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -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 deleted file mode 100644 index 5014456a13..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.Logger.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -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 deleted file mode 100644 index ec468f2df2..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.NumericalComparisonOperator.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -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 deleted file mode 100644 index e6a8a09a5c..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.Object.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -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 deleted file mode 100644 index 80e3678bda..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.PromiseLike.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -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 deleted file mode 100644 index 5d56a92f9f..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.QueuingStrategy.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index 11bb2e825c..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.QueuingStrategySize.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index b7503e2ebc..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadWriteStream.md +++ /dev/null @@ -1,1074 +0,0 @@ ---- -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 deleted file mode 100644 index c88effdad8..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableByteStreamController.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -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 deleted file mode 100644 index 0f11ac065e..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableByteStreamControllerCallback.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index f79857ad5d..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStream-1.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -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 deleted file mode 100644 index d587f24ecc..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStream.md +++ /dev/null @@ -1,906 +0,0 @@ ---- -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 deleted file mode 100644 index 072b6f2f9d..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultController.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index 9897303127..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReadDoneResult.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 88778135e6..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReadValueResult.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index 7b6181d7b0..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReader.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -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 deleted file mode 100644 index df053b8e6c..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamErrorCallback.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 250383d603..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamGenericReader.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -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 deleted file mode 100644 index 7adf7c1f69..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableWritablePair.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -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 deleted file mode 100644 index f36c48fecf..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.SharedArrayBuffer.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -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 deleted file mode 100644 index 055a95aaca..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.SharedArrayBufferConstructor.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index 4c7f45a8bf..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.StaticEventEmitterOptions.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index cf5f6aa60a..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.StreamPipeOptions.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -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 deleted file mode 100644 index b21ee5aa61..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.StringComparisonOperator.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index 66d0f01471..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.TransformOptions.md +++ /dev/null @@ -1,409 +0,0 @@ ---- -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 deleted file mode 100644 index e08df0ee84..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingByteSource.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -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 deleted file mode 100644 index 02e43bf443..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSink.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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 deleted file mode 100644 index 473597335f..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkAbortCallback.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 598d1a787c..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkCloseCallback.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -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 deleted file mode 100644 index 11cb65c2eb..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkStartCallback.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 9b5a1a1847..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkWriteCallback.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -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 deleted file mode 100644 index 76df0e3be4..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSource.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -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 deleted file mode 100644 index 39c2c51974..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourceCancelCallback.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 059ed8d2db..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourcePullCallback.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index a97ccd182e..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourceStartCallback.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 deleted file mode 100644 index 2c7098f41a..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.UpdateUserInput.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -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 deleted file mode 100644 index 0da80f36a7..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStream-1.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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 deleted file mode 100644 index c2ea4a913b..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStream.md +++ /dev/null @@ -1,815 +0,0 @@ ---- -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 deleted file mode 100644 index 52fa52e208..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStreamDefaultController.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -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 deleted file mode 100644 index 45ca32d617..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStreamDefaultWriter.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -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 deleted file mode 100644 index 833deee022..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8._DOMEventTarget.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -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 deleted file mode 100644 index cf2a0ea023..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8._NodeEventTarget.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index 1acc56684b..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.FinishedOptions.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -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 deleted file mode 100644 index 9444cb0ea0..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.Pipe.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -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 deleted file mode 100644 index 5cb75ff1e3..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.PipelineOptions.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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 deleted file mode 100644 index 768a16d0db..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.ReadableOptions.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -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 deleted file mode 100644 index 68b1d44283..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.StreamOptions.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -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 deleted file mode 100644 index d416807693..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.WritableOptions.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -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 deleted file mode 100644 index f370c9ff8c..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.CustomFindOptions.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -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 deleted file mode 100644 index 1d09581810..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.FindConfig.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -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 deleted file mode 100644 index 34c5fcc5cb..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.FulfillmentService.md +++ /dev/null @@ -1,310 +0,0 @@ ---- -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 deleted file mode 100644 index 4a3bbcdb45..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IBatchJobStrategy.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -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 deleted file mode 100644 index 8d9a462080..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ICartCompletionStrategy.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -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 deleted file mode 100644 index f0b468631c..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IFileService.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -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 deleted file mode 100644 index 86641cd7a7..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.INotificationService.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -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 deleted file mode 100644 index d19d09d5f9..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IPriceSelectionStrategy.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -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 deleted file mode 100644 index 0dbb00b900..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ITaxCalculationStrategy.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -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 deleted file mode 100644 index 90a09c90c8..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ITaxService.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -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 deleted file mode 100644 index c3c6613180..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentProcessor.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -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 deleted file mode 100644 index a808c4dff9..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentProcessorError.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 deleted file mode 100644 index eaaf2a48e5..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentService.md +++ /dev/null @@ -1,567 +0,0 @@ ---- -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/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx b/www/apps/docs/content/references/js-client/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx new file mode 100644 index 0000000000..edd55cea04 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx @@ -0,0 +1,4258 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Writable + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).Writable + +#### Since + +v0.9.4 + +## Properties + + { // 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'`.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "errorMonitor", + "type": "typeof [`errorMonitor`](../../internal/classes/admin_discounts.internal.PassThrough.mdx#errormonitor)", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[_construct](../../internal/classes/admin_discounts.internal.WritableBase.mdx#_construct) + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[_destroy](../../internal/classes/admin_discounts.internal.WritableBase.mdx#_destroy) + +___ + +### \_final + +▸ **_final**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[_final](../../internal/classes/admin_discounts.internal.WritableBase.mdx#_final) + +___ + +### \_write + +▸ **_write**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[_write](../../internal/classes/admin_discounts.internal.WritableBase.mdx#_write) + +___ + +### \_writev + +▸ `Optional` **_writev**(`chunks`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[_writev](../../internal/classes/admin_discounts.internal.WritableBase.mdx#_writev) + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +Event emitter +The defined events on documents including: +1. close +2. drain +3. error +4. finish +5. pipe +6. unpipe + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener) + +___ + +### 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](admin_discounts.internal.internal-2.Writable.mdx#uncork) or [end](admin_discounts.internal.internal-2.Writable.mdx#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/classes/admin_discounts.internal.WritableBase.mdx).[cork](../../internal/classes/admin_discounts.internal.WritableBase.mdx#cork) + +___ + +### destroy + +▸ **destroy**(`error?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +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 + + + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Since + +v8.0.0 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[destroy](../../internal/classes/admin_discounts.internal.WritableBase.mdx#destroy) + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit) + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit) + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit) + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit) + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit) + +___ + +### end + +▸ **end**(`cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +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](admin_discounts.internal.internal-2.Writable.mdx#write) method after calling [end](admin_discounts.internal.internal-2.Writable.mdx#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 + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[end](../../internal/classes/admin_discounts.internal.WritableBase.mdx#end) + +▸ **end**(`chunk`, `cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[end](../../internal/classes/admin_discounts.internal.WritableBase.mdx#end) + +▸ **end**(`chunk`, `encoding`, `cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[end](../../internal/classes/admin_discounts.internal.WritableBase.mdx#end) + +___ + +### 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/classes/admin_discounts.internal.WritableBase.mdx).[eventNames](../../internal/classes/admin_discounts.internal.WritableBase.mdx#eventnames) + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.internal-2.Writable.mdx#defaultmaxlisteners). + +#### Returns + +`number` + + + +#### Since + +v1.0.0 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[getMaxListeners](../../internal/classes/admin_discounts.internal.WritableBase.mdx#getmaxlisteners) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[listenerCount](../../internal/classes/admin_discounts.internal.WritableBase.mdx#listenercount) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[listeners](../../internal/classes/admin_discounts.internal.WritableBase.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Since + +v10.0.0 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[off](../../internal/classes/admin_discounts.internal.WritableBase.mdx#off) + +___ + +### on + +▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Since + +v0.1.101 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on) + +___ + +### once + +▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Since + +v0.3.0 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once) + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[pipe](../../internal/classes/admin_discounts.internal.WritableBase.mdx#pipe) + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependlistener) + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependOnceListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependOnceListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependOnceListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependOnceListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependOnceListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependOnceListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependOnceListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[rawListeners](../../internal/classes/admin_discounts.internal.WritableBase.mdx#rawlisteners) + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +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 + + + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeAllListeners](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removelistener) + +___ + +### setDefaultEncoding + +▸ **setDefaultEncoding**(`encoding`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream. + +#### Parameters + + + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Since + +v0.11.15 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[setDefaultEncoding](../../internal/classes/admin_discounts.internal.WritableBase.mdx#setdefaultencoding) + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +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 + + + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Since + +v0.3.5 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[setMaxListeners](../../internal/classes/admin_discounts.internal.WritableBase.mdx#setmaxlisteners) + +___ + +### uncork + +▸ **uncork**(): `void` + +The `writable.uncork()` method flushes all data buffered since [cork](admin_discounts.internal.internal-2.Writable.mdx#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/classes/admin_discounts.internal.WritableBase.mdx).[uncork](../../internal/classes/admin_discounts.internal.WritableBase.mdx#uncork) + +___ + +### 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/classes/admin_discounts.internal.PassThrough.mdx#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 + + `void`", + "description": "Callback for when this chunk of data is flushed.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Since + +v0.9.4 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[write](../../internal/classes/admin_discounts.internal.WritableBase.mdx#write) + +▸ **write**(`chunk`, `encoding`, `callback?`): `boolean` + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[write](../../internal/classes/admin_discounts.internal.WritableBase.mdx#write) + +___ + +### fromWeb + +▸ `Static` **fromWeb**(`writableStream`, `options?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + +A utility method for creating a `Writable` from a web `WritableStream`. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`WritableOptions`](../interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx), ``\"signal\"`` \\| ``\"decodeStrings\"`` \\| ``\"highWaterMark\"`` \\| ``\"objectMode\"``\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Writable`](admin_discounts.internal.internal-2.Writable.mdx) + + + +#### Since + +v17.0.0 + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v15.2.0, v14.17.0 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[getEventListeners](../../internal/classes/admin_discounts.internal.WritableBase.mdx#geteventlisteners) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.9.12 + +#### Deprecated + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[listenerCount](../../internal/classes/admin_discounts.internal.WritableBase.mdx#listenercount-1) + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../../internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`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 + + + +#### Returns + +[`AsyncIterableIterator`](../../internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "that iterates `eventName` events emitted by the `emitter`", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v13.6.0, v12.16.0 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on-1) + +___ + +### 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 + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Since + +v11.13.0, v10.16.0 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once-1) + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once-1) + +___ + +### 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 + + + +#### Returns + +`void` + + + +#### Since + +v15.4.0 + +#### Inherited from + +[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[setMaxListeners](../../internal/classes/admin_discounts.internal.WritableBase.mdx#setmaxlisteners-1) + +___ + +### toWeb + +▸ `Static` **toWeb**(`streamWritable`): [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> + +A utility method for creating a web `WritableStream` from a `Writable`. + +#### Parameters + + + +#### Returns + +[`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v17.0.0 diff --git a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.FinishedOptions.mdx b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.FinishedOptions.mdx new file mode 100644 index 0000000000..e4f2bf3b31 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.FinishedOptions.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FinishedOptions + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).FinishedOptions + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.Pipe.mdx b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.Pipe.mdx new file mode 100644 index 0000000000..bfe598a059 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.Pipe.mdx @@ -0,0 +1,93 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Pipe + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).Pipe + +## Methods + +### close + +▸ **close**(): `void` + +#### Returns + +`void` + + + +___ + +### hasRef + +▸ **hasRef**(): `boolean` + +#### Returns + +`boolean` + + + +___ + +### ref + +▸ **ref**(): `void` + +#### Returns + +`void` + + + +___ + +### unref + +▸ **unref**(): `void` + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.PipelineOptions.mdx b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.PipelineOptions.mdx new file mode 100644 index 0000000000..aee090f6e3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.PipelineOptions.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PipelineOptions + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).PipelineOptions + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx new file mode 100644 index 0000000000..291545b101 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx @@ -0,0 +1,204 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableOptions + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).ReadableOptions + +## Properties + + + +## Methods + +### construct + +▸ `Optional` **construct**(`this`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[StreamOptions](admin_discounts.internal.internal-2.StreamOptions.mdx).[construct](admin_discounts.internal.internal-2.StreamOptions.mdx#construct) + +___ + +### destroy + +▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[StreamOptions](admin_discounts.internal.internal-2.StreamOptions.mdx).[destroy](admin_discounts.internal.internal-2.StreamOptions.mdx#destroy) + +___ + +### read + +▸ `Optional` **read**(`this`, `size`): `void` + +#### Parameters + + + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.StreamOptions.mdx b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.StreamOptions.mdx new file mode 100644 index 0000000000..114dea23cc --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.StreamOptions.mdx @@ -0,0 +1,159 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StreamOptions + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).StreamOptions + +## Type parameters + + + +## Properties + + + +## Methods + +### construct + +▸ `Optional` **construct**(`this`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### destroy + +▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx new file mode 100644 index 0000000000..332c076960 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx @@ -0,0 +1,320 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# WritableOptions + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).WritableOptions + +## Properties + + + +## Methods + +### construct + +▸ `Optional` **construct**(`this`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[StreamOptions](admin_discounts.internal.internal-2.StreamOptions.mdx).[construct](admin_discounts.internal.internal-2.StreamOptions.mdx#construct) + +___ + +### destroy + +▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[StreamOptions](admin_discounts.internal.internal-2.StreamOptions.mdx).[destroy](admin_discounts.internal.internal-2.StreamOptions.mdx#destroy) + +___ + +### final + +▸ `Optional` **final**(`this`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### write + +▸ `Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### writev + +▸ `Optional` **writev**(`this`, `chunks`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.finished.mdx b/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.finished.mdx new file mode 100644 index 0000000000..4cb5712695 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.finished.mdx @@ -0,0 +1,51 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# finished + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).finished + +## Functions + +### \_\_promisify\_\_ + +▸ **__promisify__**(`stream`, `options?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.pipeline.mdx b/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.pipeline.mdx new file mode 100644 index 0000000000..9526d42f87 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.pipeline.mdx @@ -0,0 +1,582 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# pipeline + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../../internal/modules/admin_discounts.internal.internal-2.mdx).pipeline + +## Functions + +### \_\_promisify\_\_ + +▸ **__promisify__**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + + + +#### Returns + +[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **__promisify__**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T1", + "type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + + + +#### Returns + +[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **__promisify__**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T1", + "type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T2", + "type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T1`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + + + +#### Returns + +[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **__promisify__**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T1", + "type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T2", + "type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T1`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T3", + "type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T2`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + + + +#### Returns + +[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **__promisify__**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T1", + "type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T2", + "type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T1`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T3", + "type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T2`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T4", + "type": "[`PipelineTransform`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T3`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../../internal/interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + + + +#### Returns + +[`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **__promisify__**(`streams`, `options?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **__promisify__**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/addresses.internal.AddressCreatePayload.mdx b/www/apps/docs/content/references/js-client/internal/classes/addresses.internal.AddressCreatePayload.mdx new file mode 100644 index 0000000000..b5d40e3bed --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/addresses.internal.AddressCreatePayload.mdx @@ -0,0 +1,106 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AddressCreatePayload + +[addresses](../../modules/addresses.mdx).[internal](../../addresses/modules/addresses.internal.mdx).AddressCreatePayload + +#### Schema + +Address fields used when creating an address. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/addresses.internal.AddressPayload.mdx b/www/apps/docs/content/references/js-client/internal/classes/addresses.internal.AddressPayload.mdx new file mode 100644 index 0000000000..1a1e150a86 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/addresses.internal.AddressPayload.mdx @@ -0,0 +1,106 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AddressPayload + +[addresses](../../modules/addresses.mdx).[internal](../../addresses/modules/addresses.internal.mdx).AddressPayload + +#### Schema + +Address fields used when creating/updating an address. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/addresses.internal.StorePostCustomersCustomerAddressesAddressReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/addresses.internal.StorePostCustomersCustomerAddressesAddressReq.mdx new file mode 100644 index 0000000000..7033c9cb10 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/addresses.internal.StorePostCustomersCustomerAddressesAddressReq.mdx @@ -0,0 +1,108 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCustomersCustomerAddressesAddressReq + +[addresses](../../modules/addresses.mdx).[internal](../../addresses/modules/addresses.internal.mdx).StorePostCustomersCustomerAddressesAddressReq + +#### Schema + +StorePostCustomersCustomerAddressesAddressReq +anyOf: + - $ref: "#/components/schemas/AddressPayload" + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/addresses.internal.StorePostCustomersCustomerAddressesReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/addresses.internal.StorePostCustomersCustomerAddressesReq.mdx new file mode 100644 index 0000000000..b87e64e59d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/addresses.internal.StorePostCustomersCustomerAddressesReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCustomersCustomerAddressesReq + +[addresses](../../modules/addresses.mdx).[internal](../../addresses/modules/addresses.internal.mdx).StorePostCustomersCustomerAddressesReq + +#### Schema + +The Address to add to the Customer's saved addresses. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.AdminPostAuthReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.AdminPostAuthReq.mdx new file mode 100644 index 0000000000..1716b26d1c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.AdminPostAuthReq.mdx @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostAuthReq + +[admin/auth](../../modules/admin_auth.mdx).[internal](../../admin_auth/modules/admin_auth.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.BaseEntity.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.BaseEntity.mdx new file mode 100644 index 0000000000..02b896d815 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.BaseEntity.mdx @@ -0,0 +1,40 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# BaseEntity + +[admin/auth](../../modules/admin_auth.mdx).[internal](../../admin_auth/modules/admin_auth.internal.mdx).BaseEntity + +Base abstract entity for all entities + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.SoftDeletableEntity.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.SoftDeletableEntity.mdx new file mode 100644 index 0000000000..0a5d74c138 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.SoftDeletableEntity.mdx @@ -0,0 +1,48 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SoftDeletableEntity + +[admin/auth](../../modules/admin_auth.mdx).[internal](../../admin_auth/modules/admin_auth.internal.mdx).SoftDeletableEntity + +Base abstract entity for all entities + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.User.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.User.mdx new file mode 100644 index 0000000000..9486a95908 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_auth.internal.User.mdx @@ -0,0 +1,112 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# User + +[admin/auth](../../modules/admin_auth.mdx).[internal](../../admin_auth/modules/admin_auth.internal.mdx).User + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "role", + "type": "[`UserRoles`](../enums/admin_auth.internal.UserRoles.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.AdminGetBatchPaginationParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.AdminGetBatchPaginationParams.mdx new file mode 100644 index 0000000000..893fc50779 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.AdminGetBatchPaginationParams.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetBatchPaginationParams + +[admin/batch-jobs](../../modules/admin_batch_jobs.mdx).[internal](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx).AdminGetBatchPaginationParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.AdminGetBatchParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.AdminGetBatchParams.mdx new file mode 100644 index 0000000000..1288a00b50 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.AdminGetBatchParams.mdx @@ -0,0 +1,126 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetBatchParams + +[admin/batch-jobs](../../modules/admin_batch_jobs.mdx).[internal](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx).AdminGetBatchParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md b/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.AdminPostBatchesReq.mdx similarity index 56% rename from www/apps/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md rename to www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.AdminPostBatchesReq.mdx index 288bc6bc40..2758855fae 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.AdminPostBatchesReq.mdx @@ -2,11 +2,13 @@ displayed_sidebar: jsClientSidebar --- -# Class: AdminPostBatchesReq +import ParameterTypes from "@site/src/components/ParameterTypes" -[internal](../modules/internal-2.md).AdminPostBatchesReq +# AdminPostBatchesReq -**`Schema`** +[admin/batch-jobs](../../modules/admin_batch_jobs.mdx).[internal](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx).AdminPostBatchesReq + +#### Schema AdminPostBatchesReq type: object @@ -44,30 +46,29 @@ properties: ## Properties -### context - -• **context**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:108 - -___ - -### dry\_run - -• **dry\_run**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:109 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:107 +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "dry_run", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.BatchJob.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.BatchJob.mdx new file mode 100644 index 0000000000..4b087d41bc --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.BatchJob.mdx @@ -0,0 +1,202 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# BatchJob + +[admin/batch-jobs](../../modules/admin_batch_jobs.mdx).[internal](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx).BatchJob + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by_user", + "type": "[`User`](admin_auth.internal.User.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "dry_run", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "failed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "pre_processed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "processing_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "result", + "type": "{ `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: (`string` \\| [`BatchJobResultError`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#batchjobresulterror))[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: [`BatchJobResultStatDescriptor`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#batchjobresultstatdescriptor)[] } & Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`BatchJobStatus`](../enums/admin_batch_jobs.internal.BatchJobStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### loadStatus + +▸ **loadStatus**(): `void` + +#### Returns + +`void` + + + +___ + +### toJSON + +▸ **toJSON**(): [`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx) + +#### Returns + +[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx) + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.DateComparisonOperator.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.DateComparisonOperator.mdx new file mode 100644 index 0000000000..8b27b7b16d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.DateComparisonOperator.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DateComparisonOperator + +[admin/batch-jobs](../../modules/admin_batch_jobs.mdx).[internal](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx).DateComparisonOperator + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Address.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Address.mdx new file mode 100644 index 0000000000..f51940abac --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Address.mdx @@ -0,0 +1,168 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Address + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Address + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminDeleteProductsFromCollectionReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminDeleteProductsFromCollectionReq.mdx new file mode 100644 index 0000000000..a494bf70cc --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminDeleteProductsFromCollectionReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteProductsFromCollectionReq + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).AdminDeleteProductsFromCollectionReq + +#### Schema + +An array of Product IDs to remove from the Product Collection. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminGetCollectionsPaginationParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminGetCollectionsPaginationParams.mdx new file mode 100644 index 0000000000..e9d6bb9b56 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminGetCollectionsPaginationParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetCollectionsPaginationParams + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).AdminGetCollectionsPaginationParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminGetCollectionsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminGetCollectionsParams.mdx new file mode 100644 index 0000000000..7c9f21459a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminGetCollectionsParams.mdx @@ -0,0 +1,86 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetCollectionsParams + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).AdminGetCollectionsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminPostCollectionsCollectionReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminPostCollectionsCollectionReq.mdx new file mode 100644 index 0000000000..adc21027ab --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminPostCollectionsCollectionReq.mdx @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostCollectionsCollectionReq + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).AdminPostCollectionsCollectionReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminPostCollectionsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminPostCollectionsReq.mdx new file mode 100644 index 0000000000..ec0eab262a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminPostCollectionsReq.mdx @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostCollectionsReq + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).AdminPostCollectionsReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminPostProductsToCollectionReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminPostProductsToCollectionReq.mdx new file mode 100644 index 0000000000..9fb353a77e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.AdminPostProductsToCollectionReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductsToCollectionReq + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).AdminPostProductsToCollectionReq + +#### Schema + +An array of Product IDs to add to the Product Collection. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Cart.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Cart.mdx new file mode 100644 index 0000000000..039910029e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Cart.mdx @@ -0,0 +1,368 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Cart + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Cart + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](admin_collections.internal.GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](admin_collections.internal.PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](admin_collections.internal.Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/admin_collections.internal.CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimImage.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimImage.mdx new file mode 100644 index 0000000000..c569a73c82 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimImage.mdx @@ -0,0 +1,88 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimImage + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ClaimImage + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimItem.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimItem.mdx new file mode 100644 index 0000000000..3fee258c79 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimItem.mdx @@ -0,0 +1,152 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimItem + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ClaimItem + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ClaimReason`](../enums/admin_collections.internal.ClaimReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ClaimTag`](admin_collections.internal.ClaimTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimOrder.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimOrder.mdx new file mode 100644 index 0000000000..2be968694c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimOrder.mdx @@ -0,0 +1,192 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimOrder + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ClaimOrder + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/admin_collections.internal.ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](admin_collections.internal.Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](admin_collections.internal.Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/admin_collections.internal.ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimTag.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimTag.mdx new file mode 100644 index 0000000000..5bfac2afd3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ClaimTag.mdx @@ -0,0 +1,72 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimTag + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ClaimTag + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Country.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Country.mdx new file mode 100644 index 0000000000..a121eb0ad9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Country.mdx @@ -0,0 +1,78 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Country + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Country + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Currency.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Currency.mdx new file mode 100644 index 0000000000..541b491270 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Currency.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Currency + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Currency + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Customer.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Customer.mdx new file mode 100644 index 0000000000..a6c4d6e37d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Customer.mdx @@ -0,0 +1,152 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Customer + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Customer + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](admin_collections.internal.Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](admin_collections.internal.Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.CustomerGroup.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.CustomerGroup.mdx new file mode 100644 index 0000000000..9b10bb2104 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.CustomerGroup.mdx @@ -0,0 +1,88 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomerGroup + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).CustomerGroup + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](admin_collections.internal.PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Discount.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Discount.mdx new file mode 100644 index 0000000000..896b3ab529 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Discount.mdx @@ -0,0 +1,168 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Discount + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Discount + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](admin_collections.internal.Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](admin_collections.internal.DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.DiscountCondition.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.DiscountCondition.mdx new file mode 100644 index 0000000000..cfa9beadb1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.DiscountCondition.mdx @@ -0,0 +1,136 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountCondition + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).DiscountCondition + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "operator", + "type": "[`DiscountConditionOperator`](../enums/admin_collections.internal.DiscountConditionOperator.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_collections", + "type": "[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_tags", + "type": "[`ProductTag`](admin_collections.internal.ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_types", + "type": "[`ProductType`](admin_collections.internal.ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](admin_collections.internal.Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountConditionType`](../enums/admin_collections.internal.DiscountConditionType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.DiscountRule.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.DiscountRule.mdx new file mode 100644 index 0000000000..7c220a0aab --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.DiscountRule.mdx @@ -0,0 +1,104 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountRule + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).DiscountRule + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/admin_collections.internal.DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.DraftOrder.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.DraftOrder.mdx new file mode 100644 index 0000000000..40f82a8818 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.DraftOrder.mdx @@ -0,0 +1,136 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DraftOrder + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).DraftOrder + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/admin_collections.internal.DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Fulfillment.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Fulfillment.mdx new file mode 100644 index 0000000000..92c8bbbd4a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Fulfillment.mdx @@ -0,0 +1,192 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Fulfillment + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Fulfillment + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](admin_collections.internal.FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](admin_collections.internal.FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](admin_collections.internal.TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.FulfillmentItem.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.FulfillmentItem.mdx new file mode 100644 index 0000000000..3d92006e82 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.FulfillmentItem.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FulfillmentItem + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).FulfillmentItem + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.FulfillmentProvider.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.FulfillmentProvider.mdx new file mode 100644 index 0000000000..cd5af75472 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.FulfillmentProvider.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FulfillmentProvider + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).FulfillmentProvider + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.GiftCard.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.GiftCard.mdx new file mode 100644 index 0000000000..2c82d8f3a2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.GiftCard.mdx @@ -0,0 +1,144 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# GiftCard + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).GiftCard + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.GiftCardTransaction.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.GiftCardTransaction.mdx new file mode 100644 index 0000000000..b3b31177cc --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.GiftCardTransaction.mdx @@ -0,0 +1,94 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# GiftCardTransaction + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).GiftCardTransaction + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Image.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Image.mdx new file mode 100644 index 0000000000..924dcaf617 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Image.mdx @@ -0,0 +1,72 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Image + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Image + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItem.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItem.mdx new file mode 100644 index 0000000000..ca2d24b37b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItem.mdx @@ -0,0 +1,410 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# LineItem + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).LineItem + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](admin_collections.internal.OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### afterUpdateOrLoad + +▸ **afterUpdateOrLoad**(): `void` + +#### Returns + +`void` + + + +___ + +### beforeUpdate + +▸ **beforeUpdate**(): `void` + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItemAdjustment.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItemAdjustment.mdx new file mode 100644 index 0000000000..fcb0a6c5ee --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItemAdjustment.mdx @@ -0,0 +1,86 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# LineItemAdjustment + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).LineItemAdjustment + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItemTaxLine.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItemTaxLine.mdx new file mode 100644 index 0000000000..b4c873a03b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItemTaxLine.mdx @@ -0,0 +1,96 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# LineItemTaxLine + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).LineItemTaxLine + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.MoneyAmount.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.MoneyAmount.mdx new file mode 100644 index 0000000000..68c30f8ecf --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.MoneyAmount.mdx @@ -0,0 +1,168 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# MoneyAmount + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).MoneyAmount + +Base abstract entity for all entities + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Order.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Order.mdx new file mode 100644 index 0000000000..eba9e600c5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Order.mdx @@ -0,0 +1,464 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Order + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Order + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/admin_collections.internal.PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](admin_collections.internal.Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](admin_collections.internal.Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](admin_collections.internal.Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/admin_collections.internal.OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.OrderEdit.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.OrderEdit.mdx new file mode 100644 index 0000000000..46ce05bb2b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.OrderEdit.mdx @@ -0,0 +1,277 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderEdit + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).OrderEdit + +Base abstract entity for all entities + +## Properties + + + +## Methods + +### loadStatus + +▸ **loadStatus**(): `void` + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.OrderItemChange.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.OrderItemChange.mdx new file mode 100644 index 0000000000..a416fb69f4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.OrderItemChange.mdx @@ -0,0 +1,112 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderItemChange + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).OrderItemChange + +Base abstract entity for all entities + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Payment.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Payment.mdx new file mode 100644 index 0000000000..0060989423 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Payment.mdx @@ -0,0 +1,176 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Payment + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Payment + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PaymentCollection.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PaymentCollection.mdx new file mode 100644 index 0000000000..82b351c69f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PaymentCollection.mdx @@ -0,0 +1,160 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentCollection + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).PaymentCollection + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`PaymentCollectionStatus`](../enums/admin_collections.internal.PaymentCollectionStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ORDER_EDIT`](../../admin_collections/modules/admin_collections.internal.mdx#order_edit)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PaymentProvider.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PaymentProvider.mdx new file mode 100644 index 0000000000..f85f8dfbac --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PaymentProvider.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentProvider + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).PaymentProvider + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PaymentSession.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PaymentSession.mdx new file mode 100644 index 0000000000..e15347f5c4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PaymentSession.mdx @@ -0,0 +1,128 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentSession + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).PaymentSession + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_initiated", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_selected", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PriceList.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PriceList.mdx new file mode 100644 index 0000000000..3c261c6264 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.PriceList.mdx @@ -0,0 +1,128 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceList + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).PriceList + +Base abstract entity for all entities + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Product.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Product.mdx new file mode 100644 index 0000000000..0cc40cd47b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Product.mdx @@ -0,0 +1,320 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Product + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Product + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](admin_collections.internal.ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/admin_collections.internal.ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](admin_collections.internal.ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](admin_collections.internal.ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductCategory.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductCategory.mdx new file mode 100644 index 0000000000..5211c6e099 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductCategory.mdx @@ -0,0 +1,144 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductCategory + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ProductCategory + +Base abstract entity for all entities + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductCollection.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductCollection.mdx new file mode 100644 index 0000000000..f8e600c630 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductCollection.mdx @@ -0,0 +1,88 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductCollection + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ProductCollection + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](admin_collections.internal.Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductOption.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductOption.mdx new file mode 100644 index 0000000000..1056c2a1da --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductOption.mdx @@ -0,0 +1,96 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductOption + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ProductOption + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](admin_collections.internal.ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductOptionValue.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductOptionValue.mdx new file mode 100644 index 0000000000..84ce813332 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductOptionValue.mdx @@ -0,0 +1,104 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductOptionValue + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ProductOptionValue + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option", + "type": "[`ProductOption`](admin_collections.internal.ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductTag.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductTag.mdx new file mode 100644 index 0000000000..df68b7abe1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductTag.mdx @@ -0,0 +1,72 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductTag + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ProductTag + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductType.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductType.mdx new file mode 100644 index 0000000000..59d446db13 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductType.mdx @@ -0,0 +1,72 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductType + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ProductType + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductVariant.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductVariant.mdx new file mode 100644 index 0000000000..a5ec61c5ea --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductVariant.mdx @@ -0,0 +1,248 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariant + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ProductVariant + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](admin_collections.internal.ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](admin_collections.internal.MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductVariantInventoryItem.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductVariantInventoryItem.mdx new file mode 100644 index 0000000000..d6f0769aea --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ProductVariantInventoryItem.mdx @@ -0,0 +1,88 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantInventoryItem + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ProductVariantInventoryItem + +Base abstract entity for all entities + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Refund.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Refund.mdx new file mode 100644 index 0000000000..4d6b010ea0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Refund.mdx @@ -0,0 +1,120 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Refund + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Refund + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Region.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Region.mdx new file mode 100644 index 0000000000..b6c7814985 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Region.mdx @@ -0,0 +1,176 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Region + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Region + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](admin_collections.internal.PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](admin_collections.internal.TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](admin_collections.internal.TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Return.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Return.mdx new file mode 100644 index 0000000000..a44f5f2b3f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Return.mdx @@ -0,0 +1,176 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Return + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Return + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/admin_collections.internal.ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ReturnItem.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ReturnItem.mdx new file mode 100644 index 0000000000..359ebaa885 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ReturnItem.mdx @@ -0,0 +1,110 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnItem + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ReturnItem + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](admin_collections.internal.Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ReturnReason.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ReturnReason.mdx new file mode 100644 index 0000000000..b22fa81b58 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ReturnReason.mdx @@ -0,0 +1,112 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnReason + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ReturnReason + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason", + "type": "``null`` \\| [`ReturnReason`](admin_collections.internal.ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_reason_children", + "type": "[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.SalesChannel.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.SalesChannel.mdx new file mode 100644 index 0000000000..4cf024322f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.SalesChannel.mdx @@ -0,0 +1,96 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SalesChannel + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).SalesChannel + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.SalesChannelLocation.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.SalesChannelLocation.mdx new file mode 100644 index 0000000000..f19d3317e0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.SalesChannelLocation.mdx @@ -0,0 +1,80 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SalesChannelLocation + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).SalesChannelLocation + +Base abstract entity for all entities + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingMethod.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingMethod.mdx new file mode 100644 index 0000000000..432128c821 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingMethod.mdx @@ -0,0 +1,182 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingMethod + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ShippingMethod + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](admin_collections.internal.Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingMethodTaxLine.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingMethodTaxLine.mdx new file mode 100644 index 0000000000..5e03b0b7fc --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingMethodTaxLine.mdx @@ -0,0 +1,96 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingMethodTaxLine + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ShippingMethodTaxLine + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingOption.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingOption.mdx new file mode 100644 index 0000000000..73e89f17f1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingOption.mdx @@ -0,0 +1,176 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingOption + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ShippingOption + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/admin_collections.internal.ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](admin_collections.internal.FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](admin_collections.internal.ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingOptionRequirement.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingOptionRequirement.mdx new file mode 100644 index 0000000000..fbe895ae21 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingOptionRequirement.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingOptionRequirement + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ShippingOptionRequirement + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingProfile.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingProfile.mdx new file mode 100644 index 0000000000..6b8d705bc9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.ShippingProfile.mdx @@ -0,0 +1,96 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingProfile + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ShippingProfile + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](admin_collections.internal.Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/admin_collections.internal.ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Swap.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Swap.mdx new file mode 100644 index 0000000000..f8d2b3f76f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.Swap.mdx @@ -0,0 +1,216 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Swap + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Swap + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/admin_collections.internal.SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](admin_collections.internal.Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](admin_collections.internal.Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TaxLine.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TaxLine.mdx new file mode 100644 index 0000000000..37afe09102 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TaxLine.mdx @@ -0,0 +1,72 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TaxLine + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).TaxLine + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TaxProvider.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TaxProvider.mdx new file mode 100644 index 0000000000..003f52e3e8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TaxProvider.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TaxProvider + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).TaxProvider + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TaxRate.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TaxRate.mdx new file mode 100644 index 0000000000..9009730e60 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TaxRate.mdx @@ -0,0 +1,144 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TaxRate + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).TaxRate + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_type_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_types", + "type": "[`ProductType`](admin_collections.internal.ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](admin_collections.internal.Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TrackingLink.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TrackingLink.mdx new file mode 100644 index 0000000000..025acdf6b7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.TrackingLink.mdx @@ -0,0 +1,104 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TrackingLink + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).TrackingLink + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_number", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_currencies.internal.AdminGetCurrenciesParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_currencies.internal.AdminGetCurrenciesParams.mdx new file mode 100644 index 0000000000..60dd66d55d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_currencies.internal.AdminGetCurrenciesParams.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetCurrenciesParams + +[admin/currencies](../../modules/admin_currencies.mdx).[internal](../../admin_currencies/modules/admin_currencies.internal.mdx).AdminGetCurrenciesParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_currencies.internal.AdminPostCurrenciesCurrencyReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_currencies.internal.AdminPostCurrenciesCurrencyReq.mdx new file mode 100644 index 0000000000..7c295cde61 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_currencies.internal.AdminPostCurrenciesCurrencyReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostCurrenciesCurrencyReq + +[admin/currencies](../../modules/admin_currencies.mdx).[internal](../../admin_currencies/modules/admin_currencies.internal.mdx).AdminPostCurrenciesCurrencyReq + +#### Schema + +Tax included in prices of currency. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_currencies.internal.FindPaginationParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_currencies.internal.FindPaginationParams.mdx new file mode 100644 index 0000000000..3830dc37df --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_currencies.internal.FindPaginationParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FindPaginationParams + +[admin/currencies](../../modules/admin_currencies.mdx).[internal](../../admin_currencies/modules/admin_currencies.internal.mdx).FindPaginationParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.mdx new file mode 100644 index 0000000000..9c4d12e71b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteCustomerGroupsGroupCustomerBatchReq + +[admin/customer-groups](../../modules/admin_customer_groups.mdx).[internal](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx).AdminDeleteCustomerGroupsGroupCustomerBatchReq + +#### Schema + +The ids of the customers to remove + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminGetCustomerGroupsGroupParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminGetCustomerGroupsGroupParams.mdx new file mode 100644 index 0000000000..17e151da43 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminGetCustomerGroupsGroupParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetCustomerGroupsGroupParams + +[admin/customer-groups](../../modules/admin_customer_groups.mdx).[internal](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx).AdminGetCustomerGroupsGroupParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminGetCustomerGroupsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminGetCustomerGroupsParams.mdx new file mode 100644 index 0000000000..eb1e333a62 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminGetCustomerGroupsParams.mdx @@ -0,0 +1,94 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetCustomerGroupsParams + +[admin/customer-groups](../../modules/admin_customer_groups.mdx).[internal](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx).AdminGetCustomerGroupsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsGroupCustomersBatchReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsGroupCustomersBatchReq.mdx new file mode 100644 index 0000000000..b524772eda --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsGroupCustomersBatchReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostCustomerGroupsGroupCustomersBatchReq + +[admin/customer-groups](../../modules/admin_customer_groups.mdx).[internal](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx).AdminPostCustomerGroupsGroupCustomersBatchReq + +#### Schema + +The ids of the customers to add + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsGroupReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsGroupReq.mdx new file mode 100644 index 0000000000..8dc4d01fd2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsGroupReq.mdx @@ -0,0 +1,34 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostCustomerGroupsGroupReq + +[admin/customer-groups](../../modules/admin_customer_groups.mdx).[internal](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx).AdminPostCustomerGroupsGroupReq + +#### Schema + +Name of the customer group + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsReq.mdx new file mode 100644 index 0000000000..e34b5aa762 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.AdminPostCustomerGroupsReq.mdx @@ -0,0 +1,34 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostCustomerGroupsReq + +[admin/customer-groups](../../modules/admin_customer_groups.mdx).[internal](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx).AdminPostCustomerGroupsReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.CustomerGroupsBatchCustomer.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.CustomerGroupsBatchCustomer.mdx new file mode 100644 index 0000000000..ed84745bfa --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.CustomerGroupsBatchCustomer.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomerGroupsBatchCustomer + +[admin/customer-groups](../../modules/admin_customer_groups.mdx).[internal](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx).CustomerGroupsBatchCustomer + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.FilterableCustomerGroupProps.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.FilterableCustomerGroupProps.mdx new file mode 100644 index 0000000000..8b066d33de --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.FilterableCustomerGroupProps.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterableCustomerGroupProps + +[admin/customer-groups](../../modules/admin_customer_groups.mdx).[internal](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx).FilterableCustomerGroupProps + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.FindParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.FindParams.mdx new file mode 100644 index 0000000000..c26ea9fac9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.FindParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FindParams + +[admin/customer-groups](../../modules/admin_customer_groups.mdx).[internal](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx).FindParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.StringComparisonOperator.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.StringComparisonOperator.mdx new file mode 100644 index 0000000000..b042152b57 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customer_groups.internal.StringComparisonOperator.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StringComparisonOperator + +[admin/customer-groups](../../modules/admin_customer_groups.mdx).[internal](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx).StringComparisonOperator + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminGetCustomersParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminGetCustomersParams.mdx new file mode 100644 index 0000000000..91d86bc7ec --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminGetCustomersParams.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetCustomersParams + +[admin/customers](../../modules/admin_customers.mdx).[internal](../../admin_customers/modules/admin_customers.internal.mdx).AdminGetCustomersParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminListCustomerSelector.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminListCustomerSelector.mdx new file mode 100644 index 0000000000..80d91b54b3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminListCustomerSelector.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminListCustomerSelector + +[admin/customers](../../modules/admin_customers.mdx).[internal](../../admin_customers/modules/admin_customers.internal.mdx).AdminListCustomerSelector + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminPostCustomersCustomerReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminPostCustomersCustomerReq.mdx new file mode 100644 index 0000000000..d58e6f6332 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminPostCustomersCustomerReq.mdx @@ -0,0 +1,74 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostCustomersCustomerReq + +[admin/customers](../../modules/admin_customers.mdx).[internal](../../admin_customers/modules/admin_customers.internal.mdx).AdminPostCustomersCustomerReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "password", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminPostCustomersReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminPostCustomersReq.mdx new file mode 100644 index 0000000000..90ddee7b85 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.AdminPostCustomersReq.mdx @@ -0,0 +1,66 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostCustomersReq + +[admin/customers](../../modules/admin_customers.mdx).[internal](../../admin_customers/modules/admin_customers.internal.mdx).AdminPostCustomersReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "password", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.Group.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.Group.mdx new file mode 100644 index 0000000000..ed548ecb69 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_customers.internal.Group.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Group + +[admin/customers](../../modules/admin_customers.mdx).[internal](../../admin_customers/modules/admin_customers.internal.mdx).Group + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractEventBusModuleService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractEventBusModuleService.mdx new file mode 100644 index 0000000000..dbaf5e4675 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractEventBusModuleService.mdx @@ -0,0 +1,349 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AbstractEventBusModuleService + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AbstractEventBusModuleService + +## Implements + +- [`IEventBusModuleService`](../interfaces/admin_discounts.internal.IEventBusModuleService.mdx) + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### eventToSubscribersMap + +• `get` **eventToSubscribersMap**(): `Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriberdescriptor)[]\> + +#### Returns + +`Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriberdescriptor)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string \\| symbol", + "type": "`string` \\| `symbol`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "SubscriberDescriptor[]", + "type": "[`SubscriberDescriptor`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriberdescriptor)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "SubscriberDescriptor", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +## Methods + +### emit + +▸ `Abstract` **emit**<`T`\>(`eventName`, `data`, `options`): `Promise`<`void`\> + + + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Implementation of + +[IEventBusModuleService](../interfaces/admin_discounts.internal.IEventBusModuleService.mdx).[emit](../interfaces/admin_discounts.internal.IEventBusModuleService.mdx#emit) + +▸ `Abstract` **emit**<`T`\>(`data`): `Promise`<`void`\> + + + +#### Parameters + +[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Implementation of + +[IEventBusModuleService](../interfaces/admin_discounts.internal.IEventBusModuleService.mdx).[emit](../interfaces/admin_discounts.internal.IEventBusModuleService.mdx#emit) + +___ + +### storeSubscribers + +▸ `Protected` **storeSubscribers**(`«destructured»`): `void` + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__namedParameters.subscriberId", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### subscribe + +▸ **subscribe**(`eventName`, `subscriber`, `context?`): [`AbstractEventBusModuleService`](admin_discounts.internal.AbstractEventBusModuleService.mdx) + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`SubscriberContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscribercontext)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`AbstractEventBusModuleService`](admin_discounts.internal.AbstractEventBusModuleService.mdx) + + + +#### Implementation of + +[IEventBusModuleService](../interfaces/admin_discounts.internal.IEventBusModuleService.mdx).[subscribe](../interfaces/admin_discounts.internal.IEventBusModuleService.mdx#subscribe) + +___ + +### unsubscribe + +▸ **unsubscribe**(`eventName`, `subscriber`, `context`): [`AbstractEventBusModuleService`](admin_discounts.internal.AbstractEventBusModuleService.mdx) + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`SubscriberContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscribercontext)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`AbstractEventBusModuleService`](admin_discounts.internal.AbstractEventBusModuleService.mdx) + + + +#### Implementation of + +[IEventBusModuleService](../interfaces/admin_discounts.internal.IEventBusModuleService.mdx).[unsubscribe](../interfaces/admin_discounts.internal.IEventBusModuleService.mdx#unsubscribe) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractSearchService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractSearchService.mdx new file mode 100644 index 0000000000..740f56e777 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractSearchService.mdx @@ -0,0 +1,468 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AbstractSearchService + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AbstractSearchService + +## Implements + +- [`ISearchService`](../interfaces/admin_discounts.internal.ISearchService.mdx) + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### options + +• `get` **options**(): Record<`string`, `unknown`\> + +#### Returns + +Record<`string`, `unknown`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[options](../interfaces/admin_discounts.internal.ISearchService.mdx#options) + +## Methods + +### addDocuments + +▸ `Abstract` **addDocuments**(`indexName`, `documents`, `type`): `unknown` + +Used to index documents by the search engine provider + +#### Parameters + + + +#### Returns + +`unknown` + + + +#### Implementation of + +[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[addDocuments](../interfaces/admin_discounts.internal.ISearchService.mdx#adddocuments) + +___ + +### createIndex + +▸ `Abstract` **createIndex**(`indexName`, `options`): `unknown` + +Used to create an index + +#### Parameters + + + +#### Returns + +`unknown` + + + +#### Implementation of + +[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[createIndex](../interfaces/admin_discounts.internal.ISearchService.mdx#createindex) + +___ + +### deleteAllDocuments + +▸ `Abstract` **deleteAllDocuments**(`indexName`): `unknown` + +Used to delete all documents + +#### Parameters + + + +#### Returns + +`unknown` + + + +#### Implementation of + +[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[deleteAllDocuments](../interfaces/admin_discounts.internal.ISearchService.mdx#deletealldocuments) + +___ + +### deleteDocument + +▸ `Abstract` **deleteDocument**(`indexName`, `document_id`): `unknown` + +Used to delete document + +#### Parameters + + + +#### Returns + +`unknown` + + + +#### Implementation of + +[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[deleteDocument](../interfaces/admin_discounts.internal.ISearchService.mdx#deletedocument) + +___ + +### getIndex + +▸ `Abstract` **getIndex**(`indexName`): `unknown` + +Used to get an index + +#### Parameters + + + +#### Returns + +`unknown` + + + +#### Implementation of + +[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[getIndex](../interfaces/admin_discounts.internal.ISearchService.mdx#getindex) + +___ + +### replaceDocuments + +▸ `Abstract` **replaceDocuments**(`indexName`, `documents`, `type`): `unknown` + +Used to replace documents + +#### Parameters + + + +#### Returns + +`unknown` + + + +#### Implementation of + +[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[replaceDocuments](../interfaces/admin_discounts.internal.ISearchService.mdx#replacedocuments) + +___ + +### search + +▸ `Abstract` **search**(`indexName`, `query`, `options`): `unknown` + +Used to search for a document in an index + +#### Parameters + + + +#### Returns + +`unknown` + + + +#### Implementation of + +[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[search](../interfaces/admin_discounts.internal.ISearchService.mdx#search) + +___ + +### updateSettings + +▸ `Abstract` **updateSettings**(`indexName`, `settings`): `unknown` + +Used to update the settings of an index + +#### Parameters + + + +#### Returns + +`unknown` + + + +#### Implementation of + +[ISearchService](../interfaces/admin_discounts.internal.ISearchService.mdx).[updateSettings](../interfaces/admin_discounts.internal.ISearchService.mdx#updatesettings) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdditionalItem-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdditionalItem-1.mdx new file mode 100644 index 0000000000..1f08d177c2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdditionalItem-1.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdditionalItem + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdditionalItem + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdditionalItem-2.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdditionalItem-2.mdx new file mode 100644 index 0000000000..1f08d177c2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdditionalItem-2.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdditionalItem + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdditionalItem + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdditionalItem.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdditionalItem.mdx new file mode 100644 index 0000000000..1f08d177c2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdditionalItem.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdditionalItem + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdditionalItem + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminCreateCondition.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminCreateCondition.mdx new file mode 100644 index 0000000000..7796995fe4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminCreateCondition.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminCreateCondition + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminCreateCondition + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.mdx new file mode 100644 index 0000000000..251a6030e0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.mdx @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteDiscountsDiscountConditionsConditionBatchReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminGetDiscountsDiscountConditionsConditionParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminGetDiscountsDiscountConditionsConditionParams.mdx new file mode 100644 index 0000000000..dd1833aa32 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminGetDiscountsDiscountConditionsConditionParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetDiscountsDiscountConditionsConditionParams + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminGetDiscountsDiscountConditionsConditionParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminGetDiscountsDiscountRuleParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminGetDiscountsDiscountRuleParams.mdx new file mode 100644 index 0000000000..3c2cec64d9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminGetDiscountsDiscountRuleParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetDiscountsDiscountRuleParams + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminGetDiscountsDiscountRuleParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminGetDiscountsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminGetDiscountsParams.mdx new file mode 100644 index 0000000000..01962868cf --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminGetDiscountsParams.mdx @@ -0,0 +1,78 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetDiscountsParams + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminGetDiscountsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminListOrdersSelector.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminListOrdersSelector.mdx new file mode 100644 index 0000000000..a25dcbe5b6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminListOrdersSelector.mdx @@ -0,0 +1,142 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminListOrdersSelector + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminListOrdersSelector + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditions.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditions.mdx new file mode 100644 index 0000000000..a5281c64ba --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditions.mdx @@ -0,0 +1,100 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDiscountsDiscountConditions + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsCondition.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsCondition.mdx new file mode 100644 index 0000000000..67cd0d1064 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsCondition.mdx @@ -0,0 +1,85 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDiscountsDiscountConditionsCondition + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionBatchParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionBatchParams.mdx new file mode 100644 index 0000000000..a98a8268ba --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionBatchParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDiscountsDiscountConditionsConditionBatchParams + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminPostDiscountsDiscountConditionsConditionBatchParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionBatchReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionBatchReq.mdx new file mode 100644 index 0000000000..c9d961a0df --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionBatchReq.mdx @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDiscountsDiscountConditionsConditionBatchReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionParams.mdx new file mode 100644 index 0000000000..f63d00327a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDiscountsDiscountConditionsConditionParams + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminPostDiscountsDiscountConditionsConditionParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsParams.mdx new file mode 100644 index 0000000000..01919d4a75 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDiscountsDiscountConditionsParams + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminPostDiscountsDiscountConditionsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountDynamicCodesReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountDynamicCodesReq.mdx new file mode 100644 index 0000000000..0b13931740 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountDynamicCodesReq.mdx @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDiscountsDiscountDynamicCodesReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminPostDiscountsDiscountDynamicCodesReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountReq.mdx new file mode 100644 index 0000000000..5dcbead911 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountReq.mdx @@ -0,0 +1,124 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDiscountsDiscountReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminPostDiscountsDiscountReq + +#### Schema + +The ID of the Rule`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`The ID 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`Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "`string`[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`AdminUpdateDiscountRule`](admin_discounts.internal.AdminUpdateDiscountRule.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountRule.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountRule.mdx new file mode 100644 index 0000000000..db2509ddd9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsDiscountRule.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDiscountsDiscountRule + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminPostDiscountsDiscountRule + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsReq.mdx new file mode 100644 index 0000000000..2133887a6e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPostDiscountsReq.mdx @@ -0,0 +1,140 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDiscountsReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminPostDiscountsReq + +#### Schema + +A short description of the discount`fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping`The value that the discount represents. This will depend on the type of the discount.`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`Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`AdminPostDiscountsDiscountRule`](admin_discounts.internal.AdminPostDiscountsDiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPriceSelectionParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPriceSelectionParams.mdx new file mode 100644 index 0000000000..86254c8cd6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminPriceSelectionParams.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPriceSelectionParams + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminPriceSelectionParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminProductCategoriesReqBase.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminProductCategoriesReqBase.mdx new file mode 100644 index 0000000000..f174ccef43 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminProductCategoriesReqBase.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminProductCategoriesReqBase + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminProductCategoriesReqBase + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminUpdateDiscountRule.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminUpdateDiscountRule.mdx new file mode 100644 index 0000000000..9c6f03d49d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminUpdateDiscountRule.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminUpdateDiscountRule + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminUpdateDiscountRule + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminUpsertCondition.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminUpsertCondition.mdx new file mode 100644 index 0000000000..dabf3fce94 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminUpsertCondition.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminUpsertCondition + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminUpsertCondition + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminUpsertConditionsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminUpsertConditionsReq.mdx new file mode 100644 index 0000000000..a8e3ee9efa --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AdminUpsertConditionsReq.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminUpsertConditionsReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AdminUpsertConditionsReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx new file mode 100644 index 0000000000..8483752d8b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx @@ -0,0 +1,195 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Blob + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + + + +## 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`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Since + +v15.7.0, v14.18.0 + +___ + +### slice + +▸ **slice**(`start?`, `end?`, `type?`): [`Blob`](admin_discounts.internal.Blob.mdx) + +Creates and returns a new `Blob` containing a subset of this `Blob` objects +data. The original `Blob` is not altered. + +#### Parameters + + + +#### Returns + +[`Blob`](admin_discounts.internal.Blob.mdx) + + + +#### Since + +v15.7.0, v14.18.0 + +___ + +### stream + +▸ **stream**(): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> + +Returns a new `ReadableStream` that allows the content of the `Blob` to be read. + +#### Returns + +[`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v16.7.0 + +___ + +### text + +▸ **text**(): `Promise`<`string`\> + +Returns a promise that fulfills with the contents of the `Blob` decoded as a +UTF-8 string. + +#### Returns + +`Promise`<`string`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v15.7.0, v14.18.0 diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomShippingOption.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomShippingOption.mdx new file mode 100644 index 0000000000..9a6743db36 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomShippingOption.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomShippingOption + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).CustomShippingOption + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomerGroup-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomerGroup-1.mdx new file mode 100644 index 0000000000..a9c9e4e28e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomerGroup-1.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomerGroup + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).CustomerGroup + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomerGroup.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomerGroup.mdx new file mode 100644 index 0000000000..a9c9e4e28e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomerGroup.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomerGroup + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).CustomerGroup + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomerGroupUpdate.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomerGroupUpdate.mdx new file mode 100644 index 0000000000..11a6ccf5fa --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.CustomerGroupUpdate.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomerGroupUpdate + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).CustomerGroupUpdate + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount-1.mdx new file mode 100644 index 0000000000..5030e741ce --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount-1.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Discount + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Discount + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount-2.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount-2.mdx new file mode 100644 index 0000000000..5030e741ce --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount-2.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Discount + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Discount + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount-3.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount-3.mdx new file mode 100644 index 0000000000..5030e741ce --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount-3.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Discount + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Discount + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount.mdx new file mode 100644 index 0000000000..5030e741ce --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Discount.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Discount + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Discount + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx new file mode 100644 index 0000000000..10c7ae3e64 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx @@ -0,0 +1,6973 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Duplex + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + +## Implements + +- [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +## Properties + + { // 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'`.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "errorMonitor", + "type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[[asyncIterator]](admin_discounts.internal.ReadableBase.mdx#[asynciterator]) + +___ + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[_construct](admin_discounts.internal.WritableBase.mdx#_construct) + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[_construct](admin_discounts.internal.ReadableBase.mdx#_construct) + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[_destroy](admin_discounts.internal.WritableBase.mdx#_destroy) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[_destroy](admin_discounts.internal.ReadableBase.mdx#_destroy) + +___ + +### \_final + +▸ **_final**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[_final](admin_discounts.internal.WritableBase.mdx#_final) + +___ + +### \_read + +▸ **_read**(`size`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[_read](admin_discounts.internal.ReadableBase.mdx#_read) + +___ + +### \_write + +▸ **_write**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[_write](admin_discounts.internal.WritableBase.mdx#_write) + +___ + +### \_writev + +▸ `Optional` **_writev**(`chunks`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[_writev](admin_discounts.internal.WritableBase.mdx#_writev) + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[addListener](admin_discounts.internal.WritableBase.mdx#addlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[addListener](admin_discounts.internal.WritableBase.mdx#addlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[addListener](admin_discounts.internal.WritableBase.mdx#addlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[addListener](admin_discounts.internal.WritableBase.mdx#addlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[addListener](admin_discounts.internal.WritableBase.mdx#addlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[addListener](admin_discounts.internal.WritableBase.mdx#addlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[addListener](admin_discounts.internal.WritableBase.mdx#addlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.addListener + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.addListener + +#### Overrides + +ReadableBase.addListener + +▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.addListener + +#### Overrides + +ReadableBase.addListener + +▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.addListener + +#### Overrides + +ReadableBase.addListener + +▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.addListener + +#### Overrides + +ReadableBase.addListener + +___ + +### 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-2/classes/admin_discounts.internal.internal-2.Writable.mdx#uncork) or [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#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](admin_discounts.internal.WritableBase.mdx).[cork](admin_discounts.internal.WritableBase.mdx#cork) + +___ + +### destroy + +▸ **destroy**(`error?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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 + + + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v8.0.0 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[destroy](admin_discounts.internal.WritableBase.mdx#destroy) + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[destroy](admin_discounts.internal.ReadableBase.mdx#destroy) + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[emit](admin_discounts.internal.WritableBase.mdx#emit) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`, `chunk`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[emit](admin_discounts.internal.WritableBase.mdx#emit) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[emit](admin_discounts.internal.WritableBase.mdx#emit) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[emit](admin_discounts.internal.WritableBase.mdx#emit) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[emit](admin_discounts.internal.WritableBase.mdx#emit) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[emit](admin_discounts.internal.WritableBase.mdx#emit) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[emit](admin_discounts.internal.WritableBase.mdx#emit) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +WritableBase.emit + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +WritableBase.emit + +#### Overrides + +ReadableBase.emit + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +WritableBase.emit + +#### Overrides + +ReadableBase.emit + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +WritableBase.emit + +#### Overrides + +ReadableBase.emit + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +WritableBase.emit + +#### Overrides + +ReadableBase.emit + +___ + +### end + +▸ **end**(`cb?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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-2/classes/admin_discounts.internal.internal-2.Writable.mdx#write) method after calling [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#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 + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v0.9.4 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[end](admin_discounts.internal.WritableBase.mdx#end) + +▸ **end**(`chunk`, `cb?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[end](admin_discounts.internal.WritableBase.mdx#end) + +▸ **end**(`chunk`, `encoding?`, `cb?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[end](admin_discounts.internal.WritableBase.mdx#end) + +___ + +### 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](admin_discounts.internal.WritableBase.mdx).[eventNames](admin_discounts.internal.WritableBase.mdx#eventnames) + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[eventNames](admin_discounts.internal.ReadableBase.mdx#eventnames) + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.Duplex.mdx#defaultmaxlisteners). + +#### Returns + +`number` + + + +#### Since + +v1.0.0 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[getMaxListeners](admin_discounts.internal.WritableBase.mdx#getmaxlisteners) + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[getMaxListeners](admin_discounts.internal.ReadableBase.mdx#getmaxlisteners) + +___ + +### 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](admin_discounts.internal.ReadableBase.mdx).[isPaused](admin_discounts.internal.ReadableBase.mdx#ispaused) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[listenerCount](admin_discounts.internal.WritableBase.mdx#listenercount) + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[listenerCount](admin_discounts.internal.ReadableBase.mdx#listenercount) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[listeners](admin_discounts.internal.WritableBase.mdx#listeners) + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[listeners](admin_discounts.internal.ReadableBase.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v10.0.0 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[off](admin_discounts.internal.WritableBase.mdx#off) + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[off](admin_discounts.internal.ReadableBase.mdx#off) + +___ + +### on + +▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v0.1.101 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[on](admin_discounts.internal.WritableBase.mdx#on) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[on](admin_discounts.internal.WritableBase.mdx#on) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[on](admin_discounts.internal.WritableBase.mdx#on) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[on](admin_discounts.internal.WritableBase.mdx#on) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[on](admin_discounts.internal.WritableBase.mdx#on) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[on](admin_discounts.internal.WritableBase.mdx#on) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[on](admin_discounts.internal.WritableBase.mdx#on) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.on + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.on + +#### Overrides + +ReadableBase.on + +▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.on + +#### Overrides + +ReadableBase.on + +▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.on + +#### Overrides + +ReadableBase.on + +▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.on + +#### Overrides + +ReadableBase.on + +___ + +### once + +▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v0.3.0 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[once](admin_discounts.internal.WritableBase.mdx#once) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[once](admin_discounts.internal.WritableBase.mdx#once) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[once](admin_discounts.internal.WritableBase.mdx#once) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[once](admin_discounts.internal.WritableBase.mdx#once) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[once](admin_discounts.internal.WritableBase.mdx#once) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[once](admin_discounts.internal.WritableBase.mdx#once) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[once](admin_discounts.internal.WritableBase.mdx#once) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.once + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.once + +#### Overrides + +ReadableBase.once + +▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.once + +#### Overrides + +ReadableBase.once + +▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.once + +#### Overrides + +ReadableBase.once + +▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.once + +#### Overrides + +ReadableBase.once + +___ + +### pause + +▸ **pause**(): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[pause](admin_discounts.internal.ReadableBase.mdx#pause) + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[pipe](admin_discounts.internal.WritableBase.mdx#pipe) + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[pipe](admin_discounts.internal.ReadableBase.mdx#pipe) + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v6.0.0 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependListener](admin_discounts.internal.WritableBase.mdx#prependlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependListener](admin_discounts.internal.WritableBase.mdx#prependlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependListener](admin_discounts.internal.WritableBase.mdx#prependlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependListener](admin_discounts.internal.WritableBase.mdx#prependlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependListener](admin_discounts.internal.WritableBase.mdx#prependlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependListener](admin_discounts.internal.WritableBase.mdx#prependlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependListener](admin_discounts.internal.WritableBase.mdx#prependlistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.prependListener + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.prependListener + +#### Overrides + +ReadableBase.prependListener + +▸ **prependListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.prependListener + +#### Overrides + +ReadableBase.prependListener + +▸ **prependListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.prependListener + +#### Overrides + +ReadableBase.prependListener + +▸ **prependListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.prependListener + +#### Overrides + +ReadableBase.prependListener + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v6.0.0 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependOnceListener](admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependOnceListener](admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependOnceListener](admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependOnceListener](admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependOnceListener](admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependOnceListener](admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[prependOnceListener](admin_discounts.internal.WritableBase.mdx#prependoncelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.prependOnceListener + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.prependOnceListener + +#### Overrides + +ReadableBase.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.prependOnceListener + +#### Overrides + +ReadableBase.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.prependOnceListener + +#### Overrides + +ReadableBase.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.prependOnceListener + +#### Overrides + +ReadableBase.prependOnceListener + +___ + +### push + +▸ **push**(`chunk`, `encoding?`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[push](admin_discounts.internal.ReadableBase.mdx#push) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[rawListeners](admin_discounts.internal.WritableBase.mdx#rawlisteners) + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[rawListeners](admin_discounts.internal.ReadableBase.mdx#rawlisteners) + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#read) after the `'end'` event has +been emitted will return `null`. No runtime error will be raised. + +#### Parameters + + + +#### Returns + +`any` + + + +#### Since + +v0.9.4 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[read](admin_discounts.internal.ReadableBase.mdx#read) + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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 + + + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v0.1.26 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[removeAllListeners](admin_discounts.internal.WritableBase.mdx#removealllisteners) + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeAllListeners](admin_discounts.internal.ReadableBase.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v0.1.26 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[removeListener](admin_discounts.internal.WritableBase.mdx#removelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[removeListener](admin_discounts.internal.WritableBase.mdx#removelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[removeListener](admin_discounts.internal.WritableBase.mdx#removelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[removeListener](admin_discounts.internal.WritableBase.mdx#removelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[removeListener](admin_discounts.internal.WritableBase.mdx#removelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[removeListener](admin_discounts.internal.WritableBase.mdx#removelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[removeListener](admin_discounts.internal.WritableBase.mdx#removelistener) + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.removeListener + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.removeListener + +#### Overrides + +ReadableBase.removeListener + +▸ **removeListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.removeListener + +#### Overrides + +ReadableBase.removeListener + +▸ **removeListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.removeListener + +#### Overrides + +ReadableBase.removeListener + +▸ **removeListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Implementation of + +WritableBase.removeListener + +#### Overrides + +ReadableBase.removeListener + +___ + +### resume + +▸ **resume**(): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[resume](admin_discounts.internal.ReadableBase.mdx#resume) + +___ + +### setDefaultEncoding + +▸ **setDefaultEncoding**(`encoding`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream. + +#### Parameters + + + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v0.11.15 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[setDefaultEncoding](admin_discounts.internal.WritableBase.mdx#setdefaultencoding) + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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 + + + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[setEncoding](admin_discounts.internal.ReadableBase.mdx#setencoding) + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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 + + + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v0.3.5 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[setMaxListeners](admin_discounts.internal.WritableBase.mdx#setmaxlisteners) + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[setMaxListeners](admin_discounts.internal.ReadableBase.mdx#setmaxlisteners) + +___ + +### uncork + +▸ **uncork**(): `void` + +The `writable.uncork()` method flushes all data buffered since [cork](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#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](admin_discounts.internal.WritableBase.mdx).[uncork](admin_discounts.internal.WritableBase.mdx#uncork) + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +The `readable.unpipe()` method detaches a `Writable` stream previously attached +using the [pipe](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[unpipe](admin_discounts.internal.ReadableBase.mdx#unpipe) + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#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](admin_discounts.internal.PassThrough.mdx#_read) implementation on a +custom stream). Following the call to `readable.unshift()` with an immediate [push](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +`void` + + + +#### Since + +v0.9.11 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[unshift](admin_discounts.internal.ReadableBase.mdx#unshift) + +___ + +### wrap + +▸ **wrap**(`stream`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[wrap](admin_discounts.internal.ReadableBase.mdx#wrap) + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#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 + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Since + +v0.9.4 + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[write](admin_discounts.internal.WritableBase.mdx#write) + +▸ **write**(`chunk`, `cb?`): `boolean` + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Implementation of + +[WritableBase](admin_discounts.internal.WritableBase.mdx).[write](admin_discounts.internal.WritableBase.mdx#write) + +___ + +### from + +▸ `Static` **from**(`src`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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 + + \\| `ArrayBuffer` \\| [`Stream`](admin_discounts.internal.Stream.mdx) \\| [`Blob`](admin_discounts.internal.Blob.mdx) \\| [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`any`\\> \\| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\\> \\| [`AsyncGeneratorFunction`](../interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v16.8.0 + +#### Overrides + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[from](admin_discounts.internal.ReadableBase.mdx#from) + +___ + +### fromWeb + +▸ `Static` **fromWeb**(`duplexStream`, `options?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +A utility method for creating a `Duplex` from a web `ReadableStream` and `WritableStream`. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "duplexStream.writable", + "type": "[`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`DuplexOptions`](../interfaces/admin_discounts.internal.DuplexOptions.mdx), ``\"signal\"`` \\| ``\"allowHalfOpen\"`` \\| ``\"decodeStrings\"`` \\| ``\"encoding\"`` \\| ``\"highWaterMark\"`` \\| ``\"objectMode\"``\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v17.0.0 + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v15.2.0, v14.17.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[getEventListeners](admin_discounts.internal.ReadableBase.mdx#geteventlisteners) + +___ + +### isDisturbed + +▸ `Static` **isDisturbed**(`stream`): `boolean` + +Returns whether the stream has been read from or cancelled. + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Since + +v16.8.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[isDisturbed](admin_discounts.internal.ReadableBase.mdx#isdisturbed) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.9.12 + +#### Deprecated + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[listenerCount](admin_discounts.internal.ReadableBase.mdx#listenercount-1) + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`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 + + + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "that iterates `eventName` events emitted by the `emitter`", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v13.6.0, v12.16.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on-1) + +___ + +### 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 + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Since + +v11.13.0, v10.16.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once-1) + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once-1) + +___ + +### 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 + + + +#### Returns + +`void` + + + +#### Since + +v15.4.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[setMaxListeners](admin_discounts.internal.ReadableBase.mdx#setmaxlisteners-1) + +___ + +### toWeb + +▸ `Static` **toWeb**(`streamDuplex`): { `readable`: [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> ; `writable`: [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> } + +A utility method for creating a web `ReadableStream` and `WritableStream` from a `Duplex`. + +#### Parameters + + + +#### Returns + +`object` + + + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "writable", + "type": "[`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Since + +v17.0.0 diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx new file mode 100644 index 0000000000..b7cdab1693 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx @@ -0,0 +1,1560 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# EventEmitter + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + +## Properties + + { // 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'`.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "errorMonitor", + "type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[addListener](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#addlistener) + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[emit](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#emit) + +___ + +### 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/admin_discounts.internal.EventEmitter-2.mdx).[eventNames](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#eventnames) + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.EventEmitter-1.mdx#defaultmaxlisteners). + +#### Returns + +`number` + + + +#### Since + +v1.0.0 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[getMaxListeners](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#getmaxlisteners) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[listenerCount](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#listenercount) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[listeners](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + + + +#### Since + +v10.0.0 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[off](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#off) + +___ + +### on + +▸ **on**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + + + +#### Since + +v0.1.101 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[on](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#on) + +___ + +### once + +▸ **once**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + + + +#### Since + +v0.3.0 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[once](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#once) + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[prependListener](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#prependlistener) + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[prependOnceListener](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#prependoncelistener) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[rawListeners](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#rawlisteners) + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + +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 + + + +#### Returns + +[`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[removeAllListeners](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[removeListener](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#removelistener) + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + +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 + + + +#### Returns + +[`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) + + + +#### Since + +v0.3.5 + +#### Inherited from + +[EventEmitter](../interfaces/admin_discounts.internal.EventEmitter-2.mdx).[setMaxListeners](../interfaces/admin_discounts.internal.EventEmitter-2.mdx#setmaxlisteners) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v15.2.0, v14.17.0 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.9.12 + +#### Deprecated + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +NodeJS.EventEmitter.listenerCount + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`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 + + + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "that iterates `eventName` events emitted by the `emitter`", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v13.6.0, v12.16.0 + +#### Inherited from + +NodeJS.EventEmitter.on + +___ + +### 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 + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Since + +v11.13.0, v10.16.0 + +#### Inherited from + +NodeJS.EventEmitter.once + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +NodeJS.EventEmitter.once + +___ + +### 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 + + + +#### Returns + +`void` + + + +#### Since + +v15.4.0 + +#### Inherited from + +NodeJS.EventEmitter.setMaxListeners diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableCartProps.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableCartProps.mdx new file mode 100644 index 0000000000..4d97181456 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableCartProps.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterableCartProps + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).FilterableCartProps + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableDiscountProps.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableDiscountProps.mdx new file mode 100644 index 0000000000..c63b803045 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableDiscountProps.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterableDiscountProps + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).FilterableDiscountProps + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableLineItemAdjustmentProps.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableLineItemAdjustmentProps.mdx new file mode 100644 index 0000000000..1085874c47 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableLineItemAdjustmentProps.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterableLineItemAdjustmentProps + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).FilterableLineItemAdjustmentProps + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableProductProps.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableProductProps.mdx new file mode 100644 index 0000000000..8e2fd27335 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableProductProps.mdx @@ -0,0 +1,160 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterableProductProps + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).FilterableProductProps + +API Level DTOs + Validation rules + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableProductVariantProps.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableProductVariantProps.mdx new file mode 100644 index 0000000000..8f3047aafc --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FilterableProductVariantProps.mdx @@ -0,0 +1,182 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterableProductVariantProps + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).FilterableProductVariantProps + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx new file mode 100644 index 0000000000..95c037881d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx @@ -0,0 +1,145 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FlagRouter + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).FlagRouter + +## Implements + +- [`IFlagRouter`](../interfaces/admin_discounts.internal.IFlagRouter.mdx) + +## Properties + + + +## 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 + +", + "description": "The flag to check", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Implementation of + +[IFlagRouter](../interfaces/admin_discounts.internal.IFlagRouter.mdx).[isFeatureEnabled](../interfaces/admin_discounts.internal.IFlagRouter.mdx#isfeatureenabled) + +___ + +### listFlags + +▸ **listFlags**(): [`FeatureFlagsResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#featureflagsresponse-1) + +#### Returns + +[`FeatureFlagsResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#featureflagsresponse-1) + + }[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Implementation of + +[IFlagRouter](../interfaces/admin_discounts.internal.IFlagRouter.mdx).[listFlags](../interfaces/admin_discounts.internal.IFlagRouter.mdx#listflags) + +___ + +### 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 + + + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FulfillmentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FulfillmentService.mdx new file mode 100644 index 0000000000..d48d1cefc9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FulfillmentService.mdx @@ -0,0 +1,693 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FulfillmentService + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).FulfillmentService + +Handles Fulfillments + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillmentProviderService_", + "type": "[`FulfillmentProviderService`](admin_discounts.internal.internal.FulfillmentProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillmentRepository_", + "type": "`Repository`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemRepository_", + "type": "`Repository`<[`LineItem`](admin_collections.internal.LineItem.mdx)\\> & { `findByReturn`: Method findByReturn }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemService_", + "type": "[`LineItemService`](admin_discounts.internal.internal.LineItemService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantInventoryService_", + "type": "[`ProductVariantInventoryService`](admin_discounts.internal.internal.ProductVariantInventoryService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingProfileService_", + "type": "[`ShippingProfileService`](admin_discounts.internal.internal.ShippingProfileService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "totalsService_", + "type": "[`TotalsService`](admin_discounts.internal.internal.TotalsService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "trackingLinkRepository_", + "type": "`Repository`<[`TrackingLink`](admin_collections.internal.TrackingLink.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`fulfillmentOrId`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the save operation", + "children": [ + { + "name": "Fulfillment", + "type": "[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createFulfillment + +▸ **createFulfillment**(`order`, `itemsToFulfill`, `custom?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)[]\> + +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 + +", + "description": "potential custom values to add", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the created fulfillments", + "children": [ + { + "name": "Fulfillment[]", + "type": "[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Fulfillment", + "type": "[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### createShipment + +▸ **createShipment**(`fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> + +Creates a shipment by marking a fulfillment as shipped. Adds +tracking links and potentially more metadata. + +#### Parameters + + + +#### Returns + +`Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the shipped fulfillment", + "children": [ + { + "name": "Fulfillment", + "type": "[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getFulfillmentItems\_ + +▸ **getFulfillmentItems_**(`order`, `items`): `Promise`<(``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx))[]\> + +Retrieves the order line items, given an array of items. + +#### Parameters + + + +#### Returns + +`Promise`<(``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx))[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the line items generated by the transformer.", + "children": [ + { + "name": "(``null`` \\| LineItem)[]", + "type": "(``null`` \\| [`LineItem`](admin_collections.internal.LineItem.mdx))[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "``null`` \\| LineItem", + "type": "``null`` \\| [`LineItem`](admin_collections.internal.LineItem.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### partitionItems\_ + +▸ **partitionItems_**(`shippingMethods`, `items`): [`FulfillmentItemPartition`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentitempartition)[] + +#### Parameters + + + +#### Returns + +[`FulfillmentItemPartition`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentitempartition)[] + + + +___ + +### retrieve + +▸ **retrieve**(`fulfillmentId`, `config?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> + +Retrieves a fulfillment by its id. + +#### Parameters + +", + "description": "optional values to include with fulfillmentRepository query", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the fulfillment", + "children": [ + { + "name": "Fulfillment", + "type": "[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### validateFulfillmentLineItem\_ + +▸ **validateFulfillmentLineItem_**(`item`, `quantity`): ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx) + +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 + + + +#### Returns + +``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx) + + + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`FulfillmentService`](admin_discounts.internal.FulfillmentService.mdx) + +#### Parameters + + + +#### Returns + +[`FulfillmentService`](admin_discounts.internal.FulfillmentService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.GiftCard-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.GiftCard-1.mdx new file mode 100644 index 0000000000..f85f31c153 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.GiftCard-1.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# GiftCard + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).GiftCard + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.GiftCard.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.GiftCard.mdx new file mode 100644 index 0000000000..f85f31c153 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.GiftCard.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# GiftCard + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).GiftCard + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Image.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Image.mdx new file mode 100644 index 0000000000..788ce7e3e0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Image.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Image + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Image + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-1.mdx new file mode 100644 index 0000000000..a1a316a232 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-1.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Item + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Item + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-2.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-2.mdx new file mode 100644 index 0000000000..4846107c37 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-2.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Item + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Item + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-3.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-3.mdx new file mode 100644 index 0000000000..a0ac0fa8d3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-3.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Item + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Item + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`Tag`](admin_discounts.internal.Tag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-4.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-4.mdx new file mode 100644 index 0000000000..4846107c37 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-4.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Item + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Item + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-5.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-5.mdx new file mode 100644 index 0000000000..14e643c49b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-5.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Item + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Item + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-6.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-6.mdx new file mode 100644 index 0000000000..14e643c49b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item-6.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Item + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Item + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item.mdx new file mode 100644 index 0000000000..31395bfab6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Item.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Item + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Item + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx new file mode 100644 index 0000000000..a37624a72d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx @@ -0,0 +1,240 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# MedusaError + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).MedusaError + +Standardized error to be used across Medusa project. + +## Properties + + `any`", + "description": "Optional override for formatting stack traces", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "stackTraceLimit", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + + + +#### Returns + +`void` + + + +#### Inherited from + +Error.captureStackTrace diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.NotificationProvider.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.NotificationProvider.mdx new file mode 100644 index 0000000000..ca88456b3d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.NotificationProvider.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# NotificationProvider + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).NotificationProvider + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.OptionRequirement-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.OptionRequirement-1.mdx new file mode 100644 index 0000000000..34941adb88 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.OptionRequirement-1.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OptionRequirement + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).OptionRequirement + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.OptionRequirement.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.OptionRequirement.mdx new file mode 100644 index 0000000000..1c2edd111a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.OptionRequirement.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OptionRequirement + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).OptionRequirement + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.OrdersReturnItem.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.OrdersReturnItem.mdx new file mode 100644 index 0000000000..ecf60f5924 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.OrdersReturnItem.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrdersReturnItem + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).OrdersReturnItem + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx new file mode 100644 index 0000000000..5daa814fcb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx @@ -0,0 +1,6676 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PassThrough + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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. + +## Properties + + { // 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'`.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "errorMonitor", + "type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[[asyncIterator]](admin_discounts.internal.Transform.mdx#[asynciterator]) + +___ + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[_construct](admin_discounts.internal.Transform.mdx#_construct) + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[_destroy](admin_discounts.internal.Transform.mdx#_destroy) + +___ + +### \_final + +▸ **_final**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[_final](admin_discounts.internal.Transform.mdx#_final) + +___ + +### \_flush + +▸ **_flush**(`callback`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[_flush](admin_discounts.internal.Transform.mdx#_flush) + +___ + +### \_read + +▸ **_read**(`size`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[_read](admin_discounts.internal.Transform.mdx#_read) + +___ + +### \_transform + +▸ **_transform**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[_transform](admin_discounts.internal.Transform.mdx#_transform) + +___ + +### \_write + +▸ **_write**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[_write](admin_discounts.internal.Transform.mdx#_write) + +___ + +### \_writev + +▸ `Optional` **_writev**(`chunks`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[_writev](admin_discounts.internal.Transform.mdx#_writev) + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) + +___ + +### 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-2/classes/admin_discounts.internal.internal-2.Writable.mdx#uncork) or [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#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](admin_discounts.internal.Transform.mdx).[cork](admin_discounts.internal.Transform.mdx#cork) + +___ + +### destroy + +▸ **destroy**(`error?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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 + + + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v8.0.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[destroy](admin_discounts.internal.Transform.mdx#destroy) + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) + +▸ **emit**(`event`, `chunk`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) + +___ + +### end + +▸ **end**(`cb?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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-2/classes/admin_discounts.internal.internal-2.Writable.mdx#write) method after calling [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#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 + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[end](admin_discounts.internal.Transform.mdx#end) + +▸ **end**(`chunk`, `cb?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[end](admin_discounts.internal.Transform.mdx#end) + +▸ **end**(`chunk`, `encoding?`, `cb?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[end](admin_discounts.internal.Transform.mdx#end) + +___ + +### 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](admin_discounts.internal.Transform.mdx).[eventNames](admin_discounts.internal.Transform.mdx#eventnames) + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.PassThrough.mdx#defaultmaxlisteners). + +#### Returns + +`number` + + + +#### Since + +v1.0.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[getMaxListeners](admin_discounts.internal.Transform.mdx#getmaxlisteners) + +___ + +### 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](admin_discounts.internal.Transform.mdx).[isPaused](admin_discounts.internal.Transform.mdx#ispaused) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[listenerCount](admin_discounts.internal.Transform.mdx#listenercount) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[listeners](admin_discounts.internal.Transform.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v10.0.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[off](admin_discounts.internal.Transform.mdx#off) + +___ + +### on + +▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v0.1.101 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) + +▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) + +▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) + +▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) + +▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) + +▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) + +▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) + +▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) + +▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) + +▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) + +▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) + +▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) + +___ + +### once + +▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v0.3.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) + +▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) + +▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) + +▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) + +▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) + +▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) + +▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) + +▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) + +▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) + +▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) + +▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) + +▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) + +___ + +### pause + +▸ **pause**(): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[pause](admin_discounts.internal.Transform.mdx#pause) + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[pipe](admin_discounts.internal.Transform.mdx#pipe) + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependListener](admin_discounts.internal.Transform.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependListener](admin_discounts.internal.Transform.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependListener](admin_discounts.internal.Transform.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependListener](admin_discounts.internal.Transform.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependListener](admin_discounts.internal.Transform.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependListener](admin_discounts.internal.Transform.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependListener](admin_discounts.internal.Transform.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependListener](admin_discounts.internal.Transform.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependListener](admin_discounts.internal.Transform.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependListener](admin_discounts.internal.Transform.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependListener](admin_discounts.internal.Transform.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependListener](admin_discounts.internal.Transform.mdx#prependlistener) + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependOnceListener](admin_discounts.internal.Transform.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependOnceListener](admin_discounts.internal.Transform.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependOnceListener](admin_discounts.internal.Transform.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependOnceListener](admin_discounts.internal.Transform.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependOnceListener](admin_discounts.internal.Transform.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependOnceListener](admin_discounts.internal.Transform.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependOnceListener](admin_discounts.internal.Transform.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependOnceListener](admin_discounts.internal.Transform.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependOnceListener](admin_discounts.internal.Transform.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependOnceListener](admin_discounts.internal.Transform.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependOnceListener](admin_discounts.internal.Transform.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[prependOnceListener](admin_discounts.internal.Transform.mdx#prependoncelistener) + +___ + +### push + +▸ **push**(`chunk`, `encoding?`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[push](admin_discounts.internal.Transform.mdx#push) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[rawListeners](admin_discounts.internal.Transform.mdx#rawlisteners) + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#read) after the `'end'` event has +been emitted will return `null`. No runtime error will be raised. + +#### Parameters + + + +#### Returns + +`any` + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[read](admin_discounts.internal.Transform.mdx#read) + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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 + + + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[removeAllListeners](admin_discounts.internal.Transform.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[removeListener](admin_discounts.internal.Transform.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[removeListener](admin_discounts.internal.Transform.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[removeListener](admin_discounts.internal.Transform.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[removeListener](admin_discounts.internal.Transform.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[removeListener](admin_discounts.internal.Transform.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[removeListener](admin_discounts.internal.Transform.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[removeListener](admin_discounts.internal.Transform.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[removeListener](admin_discounts.internal.Transform.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[removeListener](admin_discounts.internal.Transform.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[removeListener](admin_discounts.internal.Transform.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[removeListener](admin_discounts.internal.Transform.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[removeListener](admin_discounts.internal.Transform.mdx#removelistener) + +___ + +### resume + +▸ **resume**(): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[resume](admin_discounts.internal.Transform.mdx#resume) + +___ + +### setDefaultEncoding + +▸ **setDefaultEncoding**(`encoding`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream. + +#### Parameters + + + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v0.11.15 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[setDefaultEncoding](admin_discounts.internal.Transform.mdx#setdefaultencoding) + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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 + + + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[setEncoding](admin_discounts.internal.Transform.mdx#setencoding) + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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 + + + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v0.3.5 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[setMaxListeners](admin_discounts.internal.Transform.mdx#setmaxlisteners) + +___ + +### uncork + +▸ **uncork**(): `void` + +The `writable.uncork()` method flushes all data buffered since [cork](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#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](admin_discounts.internal.Transform.mdx).[uncork](admin_discounts.internal.Transform.mdx#uncork) + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +The `readable.unpipe()` method detaches a `Writable` stream previously attached +using the [pipe](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[unpipe](admin_discounts.internal.Transform.mdx#unpipe) + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#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](admin_discounts.internal.PassThrough.mdx#_read) implementation on a +custom stream). Following the call to `readable.unshift()` with an immediate [push](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +`void` + + + +#### Since + +v0.9.11 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[unshift](admin_discounts.internal.Transform.mdx#unshift) + +___ + +### wrap + +▸ **wrap**(`stream`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) + +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](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +[`PassThrough`](admin_discounts.internal.PassThrough.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[wrap](admin_discounts.internal.Transform.mdx#wrap) + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#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 + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[write](admin_discounts.internal.Transform.mdx#write) + +▸ **write**(`chunk`, `cb?`): `boolean` + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[write](admin_discounts.internal.Transform.mdx#write) + +___ + +### from + +▸ `Static` **from**(`src`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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 + + \\| `ArrayBuffer` \\| [`Stream`](admin_discounts.internal.Stream.mdx) \\| [`Blob`](admin_discounts.internal.Blob.mdx) \\| [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`any`\\> \\| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\\> \\| [`AsyncGeneratorFunction`](../interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v16.8.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[from](admin_discounts.internal.Transform.mdx#from) + +___ + +### fromWeb + +▸ `Static` **fromWeb**(`duplexStream`, `options?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +A utility method for creating a `Duplex` from a web `ReadableStream` and `WritableStream`. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "duplexStream.writable", + "type": "[`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`DuplexOptions`](../interfaces/admin_discounts.internal.DuplexOptions.mdx), ``\"signal\"`` \\| ``\"allowHalfOpen\"`` \\| ``\"decodeStrings\"`` \\| ``\"encoding\"`` \\| ``\"highWaterMark\"`` \\| ``\"objectMode\"``\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v17.0.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[fromWeb](admin_discounts.internal.Transform.mdx#fromweb) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v15.2.0, v14.17.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[getEventListeners](admin_discounts.internal.Transform.mdx#geteventlisteners) + +___ + +### isDisturbed + +▸ `Static` **isDisturbed**(`stream`): `boolean` + +Returns whether the stream has been read from or cancelled. + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Since + +v16.8.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[isDisturbed](admin_discounts.internal.Transform.mdx#isdisturbed) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.9.12 + +#### Deprecated + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[listenerCount](admin_discounts.internal.Transform.mdx#listenercount-1) + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`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 + + + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "that iterates `eventName` events emitted by the `emitter`", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v13.6.0, v12.16.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on-1) + +___ + +### 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 + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Since + +v11.13.0, v10.16.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once-1) + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once-1) + +___ + +### 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 + + + +#### Returns + +`void` + + + +#### Since + +v15.4.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[setMaxListeners](admin_discounts.internal.Transform.mdx#setmaxlisteners-1) + +___ + +### toWeb + +▸ `Static` **toWeb**(`streamDuplex`): { `readable`: [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> ; `writable`: [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> } + +A utility method for creating a web `ReadableStream` and `WritableStream` from a `Duplex`. + +#### Parameters + + + +#### Returns + +`object` + + + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "writable", + "type": "[`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Since + +v17.0.0 + +#### Inherited from + +[Transform](admin_discounts.internal.Transform.mdx).[toWeb](admin_discounts.internal.Transform.mdx#toweb) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PaymentMethod.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PaymentMethod.mdx new file mode 100644 index 0000000000..3ba22010dc --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PaymentMethod.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentMethod + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).PaymentMethod + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PaymentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PaymentService.mdx new file mode 100644 index 0000000000..a1e7358528 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PaymentService.mdx @@ -0,0 +1,593 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentService + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).PaymentService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBusService_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentProviderService_", + "type": "[`PaymentProviderService`](admin_discounts.internal.internal.PaymentProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentRepository_", + "type": "`Repository`<[`Payment`](admin_collections.internal.Payment.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PAYMENT_CAPTURED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PAYMENT_CAPTURE_FAILED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.REFUND_CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.REFUND_FAILED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### capture + +▸ **capture**(`paymentOrId`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +Captures a payment. + +#### Parameters + + + +#### Returns + +`Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment captured.", + "children": [ + { + "name": "Payment", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`paymentInput`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +Created a new payment. + +#### Parameters + + + +#### Returns + +`Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment created.", + "children": [ + { + "name": "Payment", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### refund + +▸ **refund**(`paymentOrId`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> + +refunds a payment. + +#### Parameters + + + +#### Returns + +`Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the refund created.", + "children": [ + { + "name": "Refund", + "type": "[`Refund`](admin_collections.internal.Refund.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`paymentId`, `config?`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +Retrieves a payment by id. + +#### Parameters + +", + "description": "the config to retrieve the payment", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment.", + "children": [ + { + "name": "Payment", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`paymentId`, `data`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +Updates a payment in order to link it to an order or a swap. + +#### Parameters + + + +#### Returns + +`Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment updated.", + "children": [ + { + "name": "Payment", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PaymentService`](admin_discounts.internal.PaymentService.mdx) + +#### Parameters + + + +#### Returns + +[`PaymentService`](admin_discounts.internal.PaymentService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PriceSelectionParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PriceSelectionParams.mdx new file mode 100644 index 0000000000..a509b26545 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PriceSelectionParams.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceSelectionParams + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).PriceSelectionParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductBatchProductCategory.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductBatchProductCategory.mdx new file mode 100644 index 0000000000..8dcc541b54 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductBatchProductCategory.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductBatchProductCategory + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductBatchProductCategory + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductBatchSalesChannel.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductBatchSalesChannel.mdx new file mode 100644 index 0000000000..bc5e0e3f86 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductBatchSalesChannel.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductBatchSalesChannel + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductBatchSalesChannel + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductOptionReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductOptionReq.mdx new file mode 100644 index 0000000000..d951e8084b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductOptionReq.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductOptionReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductOptionReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductProductCategoryReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductProductCategoryReq.mdx new file mode 100644 index 0000000000..a443809138 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductProductCategoryReq.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductProductCategoryReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductProductCategoryReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductSalesChannelReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductSalesChannelReq.mdx new file mode 100644 index 0000000000..695c2e2ffb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductSalesChannelReq.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductSalesChannelReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductSalesChannelReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductTagReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductTagReq.mdx new file mode 100644 index 0000000000..c8966f2766 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductTagReq.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductTagReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductTagReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductTypeReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductTypeReq.mdx new file mode 100644 index 0000000000..3e631b7171 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductTypeReq.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductTypeReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductTypeReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq-1.mdx new file mode 100644 index 0000000000..212b59135f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq-1.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantOptionReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductVariantOptionReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq-2.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq-2.mdx new file mode 100644 index 0000000000..c396afdf31 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq-2.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantOptionReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductVariantOptionReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq-3.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq-3.mdx new file mode 100644 index 0000000000..212b59135f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq-3.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantOptionReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductVariantOptionReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq.mdx new file mode 100644 index 0000000000..212b59135f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantOptionReq.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantOptionReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductVariantOptionReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantPricesCreateReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantPricesCreateReq.mdx new file mode 100644 index 0000000000..0229ba0226 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantPricesCreateReq.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantPricesCreateReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductVariantPricesCreateReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantPricesUpdateReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantPricesUpdateReq.mdx new file mode 100644 index 0000000000..8f17887c70 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantPricesUpdateReq.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantPricesUpdateReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductVariantPricesUpdateReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantReq-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantReq-1.mdx new file mode 100644 index 0000000000..28a8940598 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantReq-1.mdx @@ -0,0 +1,174 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductVariantReq + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductVariantOptionReq`](admin_discounts.internal.ProductVariantOptionReq-3.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`ProductVariantPricesUpdateReq`](admin_discounts.internal.ProductVariantPricesUpdateReq.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantReq.mdx new file mode 100644 index 0000000000..2319c53c2d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ProductVariantReq.mdx @@ -0,0 +1,166 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantReq + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ProductVariantReq + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductVariantOptionReq`](admin_discounts.internal.ProductVariantOptionReq-2.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`ProductVariantPricesCreateReq`](admin_discounts.internal.ProductVariantPricesCreateReq.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx new file mode 100644 index 0000000000..e246b3d3ae --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx @@ -0,0 +1,4721 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Readable + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Readable + +#### Since + +v0.9.4 + +## Properties + + { // 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'`.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "errorMonitor", + "type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[[asyncIterator]](admin_discounts.internal.ReadableBase.mdx#[asynciterator]) + +___ + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[_construct](admin_discounts.internal.ReadableBase.mdx#_construct) + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[_destroy](admin_discounts.internal.ReadableBase.mdx#_destroy) + +___ + +### \_read + +▸ **_read**(`size`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[_read](admin_discounts.internal.ReadableBase.mdx#_read) + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +Event emitter +The defined events on documents including: +1. close +2. data +3. end +4. error +5. pause +6. readable +7. resume + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) + +___ + +### destroy + +▸ **destroy**(`error?`): [`Readable`](admin_discounts.internal.Readable.mdx) + +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 + + + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v8.0.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[destroy](admin_discounts.internal.ReadableBase.mdx#destroy) + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`, `chunk`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) + +___ + +### 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](admin_discounts.internal.ReadableBase.mdx).[eventNames](admin_discounts.internal.ReadableBase.mdx#eventnames) + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.Readable.mdx#defaultmaxlisteners). + +#### Returns + +`number` + + + +#### Since + +v1.0.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[getMaxListeners](admin_discounts.internal.ReadableBase.mdx#getmaxlisteners) + +___ + +### 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](admin_discounts.internal.ReadableBase.mdx).[isPaused](admin_discounts.internal.ReadableBase.mdx#ispaused) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[listenerCount](admin_discounts.internal.ReadableBase.mdx#listenercount) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[listeners](admin_discounts.internal.ReadableBase.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v10.0.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[off](admin_discounts.internal.ReadableBase.mdx#off) + +___ + +### on + +▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v0.1.101 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) + +___ + +### once + +▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v0.3.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) + +___ + +### pause + +▸ **pause**(): [`Readable`](admin_discounts.internal.Readable.mdx) + +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`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[pause](admin_discounts.internal.ReadableBase.mdx#pause) + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[pipe](admin_discounts.internal.ReadableBase.mdx#pipe) + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener) + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener) + +___ + +### push + +▸ **push**(`chunk`, `encoding?`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[push](admin_discounts.internal.ReadableBase.mdx#push) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[rawListeners](admin_discounts.internal.ReadableBase.mdx#rawlisteners) + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#read) after the `'end'` event has +been emitted will return `null`. No runtime error will be raised. + +#### Parameters + + + +#### Returns + +`any` + + + +#### Since + +v0.9.4 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[read](admin_discounts.internal.ReadableBase.mdx#read) + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`Readable`](admin_discounts.internal.Readable.mdx) + +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 + + + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeAllListeners](admin_discounts.internal.ReadableBase.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener) + +___ + +### resume + +▸ **resume**(): [`Readable`](admin_discounts.internal.Readable.mdx) + +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`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[resume](admin_discounts.internal.ReadableBase.mdx#resume) + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`Readable`](admin_discounts.internal.Readable.mdx) + +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 + + + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[setEncoding](admin_discounts.internal.ReadableBase.mdx#setencoding) + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`Readable`](admin_discounts.internal.Readable.mdx) + +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 + + + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v0.3.5 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[setMaxListeners](admin_discounts.internal.ReadableBase.mdx#setmaxlisteners) + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`Readable`](admin_discounts.internal.Readable.mdx) + +The `readable.unpipe()` method detaches a `Writable` stream previously attached +using the [pipe](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[unpipe](admin_discounts.internal.ReadableBase.mdx#unpipe) + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#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](admin_discounts.internal.PassThrough.mdx#_read) implementation on a +custom stream). Following the call to `readable.unshift()` with an immediate [push](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +`void` + + + +#### Since + +v0.9.11 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[unshift](admin_discounts.internal.ReadableBase.mdx#unshift) + +___ + +### wrap + +▸ **wrap**(`stream`): [`Readable`](admin_discounts.internal.Readable.mdx) + +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](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[wrap](admin_discounts.internal.ReadableBase.mdx#wrap) + +___ + +### from + +▸ `Static` **from**(`iterable`, `options?`): [`Readable`](admin_discounts.internal.Readable.mdx) + +A utility method for creating Readable Streams out of iterators. + +#### Parameters + + \\| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ReadableOptions`](../../internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[from](admin_discounts.internal.ReadableBase.mdx#from) + +___ + +### fromWeb + +▸ `Static` **fromWeb**(`readableStream`, `options?`): [`Readable`](admin_discounts.internal.Readable.mdx) + +A utility method for creating a `Readable` from a web `ReadableStream`. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`ReadableOptions`](../../internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx), ``\"signal\"`` \\| ``\"encoding\"`` \\| ``\"highWaterMark\"`` \\| ``\"objectMode\"``\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +#### Since + +v17.0.0 + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v15.2.0, v14.17.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[getEventListeners](admin_discounts.internal.ReadableBase.mdx#geteventlisteners) + +___ + +### isDisturbed + +▸ `Static` **isDisturbed**(`stream`): `boolean` + +Returns whether the stream has been read from or cancelled. + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Since + +v16.8.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[isDisturbed](admin_discounts.internal.ReadableBase.mdx#isdisturbed) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.9.12 + +#### Deprecated + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[listenerCount](admin_discounts.internal.ReadableBase.mdx#listenercount-1) + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`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 + + + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "that iterates `eventName` events emitted by the `emitter`", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v13.6.0, v12.16.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on-1) + +___ + +### 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 + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Since + +v11.13.0, v10.16.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once-1) + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once-1) + +___ + +### 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 + + + +#### Returns + +`void` + + + +#### Since + +v15.4.0 + +#### Inherited from + +[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[setMaxListeners](admin_discounts.internal.ReadableBase.mdx#setmaxlisteners-1) + +___ + +### toWeb + +▸ `Static` **toWeb**(`streamReadable`): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> + +A utility method for creating a web `ReadableStream` from a `Readable`. + +#### Parameters + + + +#### Returns + +[`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v17.0.0 diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx new file mode 100644 index 0000000000..3434b573f1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx @@ -0,0 +1,4871 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableBase + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + +## Implements + +- [`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) + +## Properties + + { // 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'`.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "errorMonitor", + "type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[[asyncIterator]](../interfaces/admin_discounts.internal.ReadableStream.mdx#[asynciterator]) + +___ + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### \_read + +▸ **_read**(`size`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +Event emitter +The defined events on documents including: +1. close +2. data +3. end +4. error +5. pause +6. readable +7. resume + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[addListener](../interfaces/admin_discounts.internal.ReadableStream.mdx#addlistener) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[addListener](admin_discounts.internal.Stream.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +___ + +### destroy + +▸ **destroy**(`error?`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +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 + + + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v8.0.0 + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[emit](../interfaces/admin_discounts.internal.ReadableStream.mdx#emit) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[emit](admin_discounts.internal.Stream.mdx#emit) + +▸ **emit**(`event`, `chunk`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +___ + +### 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/admin_discounts.internal.ReadableStream.mdx).[eventNames](../interfaces/admin_discounts.internal.ReadableStream.mdx#eventnames) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[eventNames](admin_discounts.internal.Stream.mdx#eventnames) + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.ReadableBase.mdx#defaultmaxlisteners). + +#### Returns + +`number` + + + +#### Since + +v1.0.0 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[getMaxListeners](../interfaces/admin_discounts.internal.ReadableStream.mdx#getmaxlisteners) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[getMaxListeners](admin_discounts.internal.Stream.mdx#getmaxlisteners) + +___ + +### 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/admin_discounts.internal.ReadableStream.mdx).[isPaused](../interfaces/admin_discounts.internal.ReadableStream.mdx#ispaused) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[listenerCount](../interfaces/admin_discounts.internal.ReadableStream.mdx#listenercount) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[listenerCount](admin_discounts.internal.Stream.mdx#listenercount) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[listeners](../interfaces/admin_discounts.internal.ReadableStream.mdx#listeners) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[listeners](admin_discounts.internal.Stream.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v10.0.0 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[off](../interfaces/admin_discounts.internal.ReadableStream.mdx#off) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[off](admin_discounts.internal.Stream.mdx#off) + +___ + +### on + +▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v0.1.101 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[on](../interfaces/admin_discounts.internal.ReadableStream.mdx#on) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[on](admin_discounts.internal.Stream.mdx#on) + +▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +___ + +### once + +▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v0.3.0 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[once](../interfaces/admin_discounts.internal.ReadableStream.mdx#once) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once) + +▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +___ + +### pause + +▸ **pause**(): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +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`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v0.9.4 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[pause](../interfaces/admin_discounts.internal.ReadableStream.mdx#pause) + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[pipe](../interfaces/admin_discounts.internal.ReadableStream.mdx#pipe) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[pipe](admin_discounts.internal.Stream.mdx#pipe) + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v6.0.0 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[prependListener](../interfaces/admin_discounts.internal.ReadableStream.mdx#prependlistener) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[prependListener](admin_discounts.internal.Stream.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v6.0.0 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[prependOnceListener](../interfaces/admin_discounts.internal.ReadableStream.mdx#prependoncelistener) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[prependOnceListener](admin_discounts.internal.Stream.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +___ + +### push + +▸ **push**(`chunk`, `encoding?`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[rawListeners](../interfaces/admin_discounts.internal.ReadableStream.mdx#rawlisteners) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[rawListeners](admin_discounts.internal.Stream.mdx#rawlisteners) + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#read) after the `'end'` event has +been emitted will return `null`. No runtime error will be raised. + +#### Parameters + + + +#### Returns + +`any` + + + +#### Since + +v0.9.4 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[read](../interfaces/admin_discounts.internal.ReadableStream.mdx#read) + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +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 + + + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v0.1.26 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[removeAllListeners](../interfaces/admin_discounts.internal.ReadableStream.mdx#removealllisteners) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[removeAllListeners](admin_discounts.internal.Stream.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v0.1.26 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[removeListener](../interfaces/admin_discounts.internal.ReadableStream.mdx#removelistener) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[removeListener](admin_discounts.internal.Stream.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +___ + +### resume + +▸ **resume**(): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +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`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v0.9.4 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[resume](../interfaces/admin_discounts.internal.ReadableStream.mdx#resume) + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +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 + + + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v0.9.4 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[setEncoding](../interfaces/admin_discounts.internal.ReadableStream.mdx#setencoding) + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +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 + + + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v0.3.5 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[setMaxListeners](../interfaces/admin_discounts.internal.ReadableStream.mdx#setmaxlisteners) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[setMaxListeners](admin_discounts.internal.Stream.mdx#setmaxlisteners) + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +The `readable.unpipe()` method detaches a `Writable` stream previously attached +using the [pipe](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v0.9.4 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[unpipe](../interfaces/admin_discounts.internal.ReadableStream.mdx#unpipe) + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#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](admin_discounts.internal.PassThrough.mdx#_read) implementation on a +custom stream). Following the call to `readable.unshift()` with an immediate [push](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +`void` + + + +#### Since + +v0.9.11 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[unshift](../interfaces/admin_discounts.internal.ReadableStream.mdx#unshift) + +___ + +### wrap + +▸ **wrap**(`stream`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + +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](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +[`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) + + + +#### Since + +v0.9.4 + +#### Implementation of + +[ReadableStream](../interfaces/admin_discounts.internal.ReadableStream.mdx).[wrap](../interfaces/admin_discounts.internal.ReadableStream.mdx#wrap) + +___ + +### from + +▸ `Static` **from**(`iterable`, `options?`): [`Readable`](admin_discounts.internal.Readable.mdx) + +A utility method for creating Readable Streams out of iterators. + +#### Parameters + + \\| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ReadableOptions`](../../internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Readable`](admin_discounts.internal.Readable.mdx) + + + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v15.2.0, v14.17.0 + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[getEventListeners](admin_discounts.internal.Stream.mdx#geteventlisteners) + +___ + +### isDisturbed + +▸ `Static` **isDisturbed**(`stream`): `boolean` + +Returns whether the stream has been read from or cancelled. + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Since + +v16.8.0 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.9.12 + +#### Deprecated + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[listenerCount](admin_discounts.internal.Stream.mdx#listenercount-1) + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`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 + + + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "that iterates `eventName` events emitted by the `emitter`", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v13.6.0, v12.16.0 + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[on](admin_discounts.internal.Stream.mdx#on-1) + +___ + +### 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 + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Since + +v11.13.0, v10.16.0 + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once-1) + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once-1) + +___ + +### 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 + + + +#### Returns + +`void` + + + +#### Since + +v15.4.0 + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[setMaxListeners](admin_discounts.internal.Stream.mdx#setmaxlisteners-1) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnItem.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnItem.mdx new file mode 100644 index 0000000000..f20914f6e9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnItem.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnItem + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReturnItem + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping-1.mdx new file mode 100644 index 0000000000..dbd53a653a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping-1.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnShipping + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReturnShipping + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping-2.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping-2.mdx new file mode 100644 index 0000000000..6dfe486b2d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping-2.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnShipping + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReturnShipping + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping-3.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping-3.mdx new file mode 100644 index 0000000000..ff737f7a30 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping-3.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnShipping + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReturnShipping + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping.mdx new file mode 100644 index 0000000000..6dfe486b2d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReturnShipping.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnShipping + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReturnShipping + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod-1.mdx new file mode 100644 index 0000000000..46d86f55a2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod-1.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingMethod + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ShippingMethod + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod-2.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod-2.mdx new file mode 100644 index 0000000000..46d86f55a2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod-2.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingMethod + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ShippingMethod + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod-3.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod-3.mdx new file mode 100644 index 0000000000..c71b1c04af --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod-3.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingMethod + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ShippingMethod + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "Record<`string`, `unknown`\\>[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod.mdx new file mode 100644 index 0000000000..58118ae842 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ShippingMethod.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingMethod + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ShippingMethod + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.StockLocationAddress-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.StockLocationAddress-1.mdx new file mode 100644 index 0000000000..398347bbe7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.StockLocationAddress-1.mdx @@ -0,0 +1,78 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StockLocationAddress + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).StockLocationAddress + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.StockLocationAddress.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.StockLocationAddress.mdx new file mode 100644 index 0000000000..cfdb9a2762 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.StockLocationAddress.mdx @@ -0,0 +1,82 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StockLocationAddress + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).StockLocationAddress + +#### Schema + +The 2 character ISO code for the country. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx new file mode 100644 index 0000000000..b6af788eb9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx @@ -0,0 +1,1620 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Stream + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + +## Properties + + { // 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'`.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "errorMonitor", + "type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Stream`](admin_discounts.internal.Stream.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[addListener](admin_discounts.internal.internal-5.mdx#addlistener) + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[emit](admin_discounts.internal.internal-5.mdx#emit) + +___ + +### 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](admin_discounts.internal.internal-5.mdx).[eventNames](admin_discounts.internal.internal-5.mdx#eventnames) + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.Stream.mdx#defaultmaxlisteners). + +#### Returns + +`number` + + + +#### Since + +v1.0.0 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[getMaxListeners](admin_discounts.internal.internal-5.mdx#getmaxlisteners) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[listenerCount](admin_discounts.internal.internal-5.mdx#listenercount) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[listeners](admin_discounts.internal.internal-5.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Stream`](admin_discounts.internal.Stream.mdx) + + + +#### Since + +v10.0.0 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[off](admin_discounts.internal.internal-5.mdx#off) + +___ + +### on + +▸ **on**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Stream`](admin_discounts.internal.Stream.mdx) + + + +#### Since + +v0.1.101 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[on](admin_discounts.internal.internal-5.mdx#on) + +___ + +### once + +▸ **once**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Stream`](admin_discounts.internal.Stream.mdx) + + + +#### Since + +v0.3.0 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[once](admin_discounts.internal.internal-5.mdx#once) + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[pipe](admin_discounts.internal.internal-5.mdx#pipe) + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Stream`](admin_discounts.internal.Stream.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[prependListener](admin_discounts.internal.internal-5.mdx#prependlistener) + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Stream`](admin_discounts.internal.Stream.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[prependOnceListener](admin_discounts.internal.internal-5.mdx#prependoncelistener) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[rawListeners](admin_discounts.internal.internal-5.mdx#rawlisteners) + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`Stream`](admin_discounts.internal.Stream.mdx) + +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 + + + +#### Returns + +[`Stream`](admin_discounts.internal.Stream.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[removeAllListeners](admin_discounts.internal.internal-5.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Stream`](admin_discounts.internal.Stream.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[removeListener](admin_discounts.internal.internal-5.mdx#removelistener) + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`Stream`](admin_discounts.internal.Stream.mdx) + +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 + + + +#### Returns + +[`Stream`](admin_discounts.internal.Stream.mdx) + + + +#### Since + +v0.3.5 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[setMaxListeners](admin_discounts.internal.internal-5.mdx#setmaxlisteners) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v15.2.0, v14.17.0 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[getEventListeners](admin_discounts.internal.internal-5.mdx#geteventlisteners) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.9.12 + +#### Deprecated + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[listenerCount](admin_discounts.internal.internal-5.mdx#listenercount-1) + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`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 + + + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "that iterates `eventName` events emitted by the `emitter`", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v13.6.0, v12.16.0 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[on](admin_discounts.internal.internal-5.mdx#on-1) + +___ + +### 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 + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Since + +v11.13.0, v10.16.0 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[once](admin_discounts.internal.internal-5.mdx#once-1) + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[once](admin_discounts.internal.internal-5.mdx#once-1) + +___ + +### 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 + + + +#### Returns + +`void` + + + +#### Since + +v15.4.0 + +#### Inherited from + +[internal](admin_discounts.internal.internal-5.mdx).[setMaxListeners](admin_discounts.internal.internal-5.mdx#setmaxlisteners-1) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Tag.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Tag.mdx new file mode 100644 index 0000000000..985f99fbc8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Tag.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Tag + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Tag + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx new file mode 100644 index 0000000000..5d59bb2518 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx @@ -0,0 +1,6678 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Transform + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + +## Properties + + { // 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'`.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "errorMonitor", + "type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[[asyncIterator]](admin_discounts.internal.Duplex.mdx#[asynciterator]) + +___ + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[_construct](admin_discounts.internal.Duplex.mdx#_construct) + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[_destroy](admin_discounts.internal.Duplex.mdx#_destroy) + +___ + +### \_final + +▸ **_final**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[_final](admin_discounts.internal.Duplex.mdx#_final) + +___ + +### \_flush + +▸ **_flush**(`callback`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### \_read + +▸ **_read**(`size`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[_read](admin_discounts.internal.Duplex.mdx#_read) + +___ + +### \_transform + +▸ **_transform**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### \_write + +▸ **_write**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[_write](admin_discounts.internal.Duplex.mdx#_write) + +___ + +### \_writev + +▸ `Optional` **_writev**(`chunks`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[_writev](admin_discounts.internal.Duplex.mdx#_writev) + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) + +___ + +### 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-2/classes/admin_discounts.internal.internal-2.Writable.mdx#uncork) or [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#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](admin_discounts.internal.Duplex.mdx).[cork](admin_discounts.internal.Duplex.mdx#cork) + +___ + +### destroy + +▸ **destroy**(`error?`): [`Transform`](admin_discounts.internal.Transform.mdx) + +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 + + + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v8.0.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[destroy](admin_discounts.internal.Duplex.mdx#destroy) + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`, `chunk`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) + +___ + +### end + +▸ **end**(`cb?`): [`Transform`](admin_discounts.internal.Transform.mdx) + +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-2/classes/admin_discounts.internal.internal-2.Writable.mdx#write) method after calling [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#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 + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[end](admin_discounts.internal.Duplex.mdx#end) + +▸ **end**(`chunk`, `cb?`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[end](admin_discounts.internal.Duplex.mdx#end) + +▸ **end**(`chunk`, `encoding?`, `cb?`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[end](admin_discounts.internal.Duplex.mdx#end) + +___ + +### 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](admin_discounts.internal.Duplex.mdx).[eventNames](admin_discounts.internal.Duplex.mdx#eventnames) + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.Transform.mdx#defaultmaxlisteners). + +#### Returns + +`number` + + + +#### Since + +v1.0.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[getMaxListeners](admin_discounts.internal.Duplex.mdx#getmaxlisteners) + +___ + +### 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](admin_discounts.internal.Duplex.mdx).[isPaused](admin_discounts.internal.Duplex.mdx#ispaused) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[listenerCount](admin_discounts.internal.Duplex.mdx#listenercount) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[listeners](admin_discounts.internal.Duplex.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v10.0.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[off](admin_discounts.internal.Duplex.mdx#off) + +___ + +### on + +▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v0.1.101 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) + +___ + +### once + +▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v0.3.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) + +___ + +### pause + +▸ **pause**(): [`Transform`](admin_discounts.internal.Transform.mdx) + +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`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[pause](admin_discounts.internal.Duplex.mdx#pause) + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[pipe](admin_discounts.internal.Duplex.mdx#pipe) + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependListener](admin_discounts.internal.Duplex.mdx#prependlistener) + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[prependOnceListener](admin_discounts.internal.Duplex.mdx#prependoncelistener) + +___ + +### push + +▸ **push**(`chunk`, `encoding?`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[push](admin_discounts.internal.Duplex.mdx#push) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[rawListeners](admin_discounts.internal.Duplex.mdx#rawlisteners) + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#read) after the `'end'` event has +been emitted will return `null`. No runtime error will be raised. + +#### Parameters + + + +#### Returns + +`any` + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[read](admin_discounts.internal.Duplex.mdx#read) + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`Transform`](admin_discounts.internal.Transform.mdx) + +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 + + + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeAllListeners](admin_discounts.internal.Duplex.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[removeListener](admin_discounts.internal.Duplex.mdx#removelistener) + +___ + +### resume + +▸ **resume**(): [`Transform`](admin_discounts.internal.Transform.mdx) + +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`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[resume](admin_discounts.internal.Duplex.mdx#resume) + +___ + +### setDefaultEncoding + +▸ **setDefaultEncoding**(`encoding`): [`Transform`](admin_discounts.internal.Transform.mdx) + +The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream. + +#### Parameters + + + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v0.11.15 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[setDefaultEncoding](admin_discounts.internal.Duplex.mdx#setdefaultencoding) + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`Transform`](admin_discounts.internal.Transform.mdx) + +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 + + + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[setEncoding](admin_discounts.internal.Duplex.mdx#setencoding) + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`Transform`](admin_discounts.internal.Transform.mdx) + +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 + + + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v0.3.5 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[setMaxListeners](admin_discounts.internal.Duplex.mdx#setmaxlisteners) + +___ + +### uncork + +▸ **uncork**(): `void` + +The `writable.uncork()` method flushes all data buffered since [cork](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#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](admin_discounts.internal.Duplex.mdx).[uncork](admin_discounts.internal.Duplex.mdx#uncork) + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`Transform`](admin_discounts.internal.Transform.mdx) + +The `readable.unpipe()` method detaches a `Writable` stream previously attached +using the [pipe](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[unpipe](admin_discounts.internal.Duplex.mdx#unpipe) + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#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](admin_discounts.internal.PassThrough.mdx#_read) implementation on a +custom stream). Following the call to `readable.unshift()` with an immediate [push](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +`void` + + + +#### Since + +v0.9.11 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[unshift](admin_discounts.internal.Duplex.mdx#unshift) + +___ + +### wrap + +▸ **wrap**(`stream`): [`Transform`](admin_discounts.internal.Transform.mdx) + +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](admin_discounts.internal.PassThrough.mdx#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 + + + +#### Returns + +[`Transform`](admin_discounts.internal.Transform.mdx) + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[wrap](admin_discounts.internal.Duplex.mdx#wrap) + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#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 + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Since + +v0.9.4 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[write](admin_discounts.internal.Duplex.mdx#write) + +▸ **write**(`chunk`, `cb?`): `boolean` + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[write](admin_discounts.internal.Duplex.mdx#write) + +___ + +### from + +▸ `Static` **from**(`src`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +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 + + \\| `ArrayBuffer` \\| [`Stream`](admin_discounts.internal.Stream.mdx) \\| [`Blob`](admin_discounts.internal.Blob.mdx) \\| [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`any`\\> \\| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\\> \\| [`AsyncGeneratorFunction`](../interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v16.8.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[from](admin_discounts.internal.Duplex.mdx#from) + +___ + +### fromWeb + +▸ `Static` **fromWeb**(`duplexStream`, `options?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) + +A utility method for creating a `Duplex` from a web `ReadableStream` and `WritableStream`. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "duplexStream.writable", + "type": "[`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`DuplexOptions`](../interfaces/admin_discounts.internal.DuplexOptions.mdx), ``\"signal\"`` \\| ``\"allowHalfOpen\"`` \\| ``\"decodeStrings\"`` \\| ``\"encoding\"`` \\| ``\"highWaterMark\"`` \\| ``\"objectMode\"``\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Duplex`](admin_discounts.internal.Duplex.mdx) + + + +#### Since + +v17.0.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[fromWeb](admin_discounts.internal.Duplex.mdx#fromweb) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v15.2.0, v14.17.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[getEventListeners](admin_discounts.internal.Duplex.mdx#geteventlisteners) + +___ + +### isDisturbed + +▸ `Static` **isDisturbed**(`stream`): `boolean` + +Returns whether the stream has been read from or cancelled. + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Since + +v16.8.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[isDisturbed](admin_discounts.internal.Duplex.mdx#isdisturbed) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.9.12 + +#### Deprecated + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[listenerCount](admin_discounts.internal.Duplex.mdx#listenercount-1) + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`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 + + + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "that iterates `eventName` events emitted by the `emitter`", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v13.6.0, v12.16.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on-1) + +___ + +### 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 + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Since + +v11.13.0, v10.16.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once-1) + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once-1) + +___ + +### 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 + + + +#### Returns + +`void` + + + +#### Since + +v15.4.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[setMaxListeners](admin_discounts.internal.Duplex.mdx#setmaxlisteners-1) + +___ + +### toWeb + +▸ `Static` **toWeb**(`streamDuplex`): { `readable`: [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> ; `writable`: [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> } + +A utility method for creating a web `ReadableStream` and `WritableStream` from a `Duplex`. + +#### Parameters + + + +#### Returns + +`object` + + + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "writable", + "type": "[`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Since + +v17.0.0 + +#### Inherited from + +[Duplex](admin_discounts.internal.Duplex.mdx).[toWeb](admin_discounts.internal.Duplex.mdx#toweb) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx new file mode 100644 index 0000000000..7c35c72cb5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx @@ -0,0 +1,4372 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# WritableBase + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + +## Implements + +- [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + +## Implemented by + +- [`Duplex`](admin_discounts.internal.Duplex.mdx) + +## Properties + + { // 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'`.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "errorMonitor", + "type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### \_final + +▸ **_final**(`callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### \_write + +▸ **_write**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### \_writev + +▸ `Optional` **_writev**(`chunks`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +Event emitter +The defined events on documents including: +1. close +2. drain +3. error +4. finish +5. pipe +6. unpipe + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[addListener](../interfaces/admin_discounts.internal.WritableStream.mdx#addlistener) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[addListener](admin_discounts.internal.Stream.mdx#addlistener) + +▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.addListener + +#### Overrides + +Stream.addListener + +▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.addListener + +#### Overrides + +Stream.addListener + +▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.addListener + +#### Overrides + +Stream.addListener + +▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.addListener + +#### Overrides + +Stream.addListener + +▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.addListener + +#### Overrides + +Stream.addListener + +▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.addListener + +#### Overrides + +Stream.addListener + +___ + +### 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-2/classes/admin_discounts.internal.internal-2.Writable.mdx#uncork) or [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#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 + +___ + +### destroy + +▸ **destroy**(`error?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +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 + + + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Since + +v8.0.0 + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[emit](../interfaces/admin_discounts.internal.WritableStream.mdx#emit) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[emit](admin_discounts.internal.Stream.mdx#emit) + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +NodeJS.WritableStream.emit + +#### Overrides + +Stream.emit + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +NodeJS.WritableStream.emit + +#### Overrides + +Stream.emit + +▸ **emit**(`event`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +NodeJS.WritableStream.emit + +#### Overrides + +Stream.emit + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +NodeJS.WritableStream.emit + +#### Overrides + +Stream.emit + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +NodeJS.WritableStream.emit + +#### Overrides + +Stream.emit + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Implementation of + +NodeJS.WritableStream.emit + +#### Overrides + +Stream.emit + +___ + +### end + +▸ **end**(`cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +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-2/classes/admin_discounts.internal.internal-2.Writable.mdx#write) method after calling [end](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#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 + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Since + +v0.9.4 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[end](../interfaces/admin_discounts.internal.WritableStream.mdx#end) + +▸ **end**(`chunk`, `cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[end](../interfaces/admin_discounts.internal.WritableStream.mdx#end) + +▸ **end**(`chunk`, `encoding`, `cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[end](../interfaces/admin_discounts.internal.WritableStream.mdx#end) + +___ + +### 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/admin_discounts.internal.WritableStream.mdx).[eventNames](../interfaces/admin_discounts.internal.WritableStream.mdx#eventnames) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[eventNames](admin_discounts.internal.Stream.mdx#eventnames) + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.WritableBase.mdx#defaultmaxlisteners). + +#### Returns + +`number` + + + +#### Since + +v1.0.0 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[getMaxListeners](../interfaces/admin_discounts.internal.WritableStream.mdx#getmaxlisteners) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[getMaxListeners](admin_discounts.internal.Stream.mdx#getmaxlisteners) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[listenerCount](../interfaces/admin_discounts.internal.WritableStream.mdx#listenercount) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[listenerCount](admin_discounts.internal.Stream.mdx#listenercount) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[listeners](../interfaces/admin_discounts.internal.WritableStream.mdx#listeners) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[listeners](admin_discounts.internal.Stream.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Since + +v10.0.0 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[off](../interfaces/admin_discounts.internal.WritableStream.mdx#off) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[off](admin_discounts.internal.Stream.mdx#off) + +___ + +### on + +▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Since + +v0.1.101 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[on](../interfaces/admin_discounts.internal.WritableStream.mdx#on) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[on](admin_discounts.internal.Stream.mdx#on) + +▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.on + +#### Overrides + +Stream.on + +▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.on + +#### Overrides + +Stream.on + +▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.on + +#### Overrides + +Stream.on + +▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.on + +#### Overrides + +Stream.on + +▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.on + +#### Overrides + +Stream.on + +▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.on + +#### Overrides + +Stream.on + +___ + +### once + +▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Since + +v0.3.0 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[once](../interfaces/admin_discounts.internal.WritableStream.mdx#once) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once) + +▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.once + +#### Overrides + +Stream.once + +▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.once + +#### Overrides + +Stream.once + +▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.once + +#### Overrides + +Stream.once + +▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.once + +#### Overrides + +Stream.once + +▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.once + +#### Overrides + +Stream.once + +▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.once + +#### Overrides + +Stream.once + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[pipe](admin_discounts.internal.Stream.mdx#pipe) + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Since + +v6.0.0 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[prependListener](../interfaces/admin_discounts.internal.WritableStream.mdx#prependlistener) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[prependListener](admin_discounts.internal.Stream.mdx#prependlistener) + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.prependListener + +#### Overrides + +Stream.prependListener + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.prependListener + +#### Overrides + +Stream.prependListener + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.prependListener + +#### Overrides + +Stream.prependListener + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.prependListener + +#### Overrides + +Stream.prependListener + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.prependListener + +#### Overrides + +Stream.prependListener + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.prependListener + +#### Overrides + +Stream.prependListener + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Since + +v6.0.0 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[prependOnceListener](../interfaces/admin_discounts.internal.WritableStream.mdx#prependoncelistener) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[prependOnceListener](admin_discounts.internal.Stream.mdx#prependoncelistener) + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[rawListeners](../interfaces/admin_discounts.internal.WritableStream.mdx#rawlisteners) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[rawListeners](admin_discounts.internal.Stream.mdx#rawlisteners) + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +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 + + + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Since + +v0.1.26 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[removeAllListeners](../interfaces/admin_discounts.internal.WritableStream.mdx#removealllisteners) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[removeAllListeners](admin_discounts.internal.Stream.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Since + +v0.1.26 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[removeListener](../interfaces/admin_discounts.internal.WritableStream.mdx#removelistener) + +#### Overrides + +[Stream](admin_discounts.internal.Stream.mdx).[removeListener](admin_discounts.internal.Stream.mdx#removelistener) + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.removeListener + +#### Overrides + +Stream.removeListener + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.removeListener + +#### Overrides + +Stream.removeListener + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.removeListener + +#### Overrides + +Stream.removeListener + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.removeListener + +#### Overrides + +Stream.removeListener + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.removeListener + +#### Overrides + +Stream.removeListener + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Implementation of + +NodeJS.WritableStream.removeListener + +#### Overrides + +Stream.removeListener + +___ + +### setDefaultEncoding + +▸ **setDefaultEncoding**(`encoding`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream. + +#### Parameters + + + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Since + +v0.11.15 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) + +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 + + + +#### Returns + +[`WritableBase`](admin_discounts.internal.WritableBase.mdx) + + + +#### Since + +v0.3.5 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[setMaxListeners](../interfaces/admin_discounts.internal.WritableStream.mdx#setmaxlisteners) + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[setMaxListeners](admin_discounts.internal.Stream.mdx#setmaxlisteners) + +___ + +### uncork + +▸ **uncork**(): `void` + +The `writable.uncork()` method flushes all data buffered since [cork](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx#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 + +___ + +### 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](admin_discounts.internal.PassThrough.mdx#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 + + `void`", + "description": "Callback for when this chunk of data is flushed.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Since + +v0.9.4 + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[write](../interfaces/admin_discounts.internal.WritableStream.mdx#write) + +▸ **write**(`chunk`, `encoding`, `callback?`): `boolean` + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Implementation of + +[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[write](../interfaces/admin_discounts.internal.WritableStream.mdx#write) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v15.2.0, v14.17.0 + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[getEventListeners](admin_discounts.internal.Stream.mdx#geteventlisteners) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.9.12 + +#### Deprecated + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[listenerCount](admin_discounts.internal.Stream.mdx#listenercount-1) + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`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 + + + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "that iterates `eventName` events emitted by the `emitter`", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v13.6.0, v12.16.0 + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[on](admin_discounts.internal.Stream.mdx#on-1) + +___ + +### 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 + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Since + +v11.13.0, v10.16.0 + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once-1) + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once-1) + +___ + +### 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 + + + +#### Returns + +`void` + + + +#### Since + +v15.4.0 + +#### Inherited from + +[Stream](admin_discounts.internal.Stream.mdx).[setMaxListeners](admin_discounts.internal.Stream.mdx#setmaxlisteners-1) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx new file mode 100644 index 0000000000..e4b5ea625c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx @@ -0,0 +1,1616 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + +## Properties + + { // 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'`.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "errorMonitor", + "type": "typeof [`errorMonitor`](admin_discounts.internal.PassThrough.mdx#errormonitor)", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`internal`](admin_discounts.internal.internal-5.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[addListener](admin_discounts.internal.EventEmitter-1.mdx#addlistener) + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[emit](admin_discounts.internal.EventEmitter-1.mdx#emit) + +___ + +### 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](admin_discounts.internal.EventEmitter-1.mdx).[eventNames](admin_discounts.internal.EventEmitter-1.mdx#eventnames) + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.internal-5.mdx#defaultmaxlisteners). + +#### Returns + +`number` + + + +#### Since + +v1.0.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[getMaxListeners](admin_discounts.internal.EventEmitter-1.mdx#getmaxlisteners) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[listenerCount](admin_discounts.internal.EventEmitter-1.mdx#listenercount) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[listeners](admin_discounts.internal.EventEmitter-1.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`internal`](admin_discounts.internal.internal-5.mdx) + + + +#### Since + +v10.0.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[off](admin_discounts.internal.EventEmitter-1.mdx#off) + +___ + +### on + +▸ **on**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`internal`](admin_discounts.internal.internal-5.mdx) + + + +#### Since + +v0.1.101 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[on](admin_discounts.internal.EventEmitter-1.mdx#on) + +___ + +### once + +▸ **once**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`internal`](admin_discounts.internal.internal-5.mdx) + + + +#### Since + +v0.3.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[once](admin_discounts.internal.EventEmitter-1.mdx#once) + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`internal`](admin_discounts.internal.internal-5.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[prependListener](admin_discounts.internal.EventEmitter-1.mdx#prependlistener) + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`internal`](admin_discounts.internal.internal-5.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[prependOnceListener](admin_discounts.internal.EventEmitter-1.mdx#prependoncelistener) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[rawListeners](admin_discounts.internal.EventEmitter-1.mdx#rawlisteners) + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`internal`](admin_discounts.internal.internal-5.mdx) + +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 + + + +#### Returns + +[`internal`](admin_discounts.internal.internal-5.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[removeAllListeners](admin_discounts.internal.EventEmitter-1.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`internal`](admin_discounts.internal.internal-5.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[removeListener](admin_discounts.internal.EventEmitter-1.mdx#removelistener) + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`internal`](admin_discounts.internal.internal-5.mdx) + +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 + + + +#### Returns + +[`internal`](admin_discounts.internal.internal-5.mdx) + + + +#### Since + +v0.3.5 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[setMaxListeners](admin_discounts.internal.EventEmitter-1.mdx#setmaxlisteners) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v15.2.0, v14.17.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[getEventListeners](admin_discounts.internal.EventEmitter-1.mdx#geteventlisteners) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.9.12 + +#### Deprecated + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[listenerCount](admin_discounts.internal.EventEmitter-1.mdx#listenercount-1) + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`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 + + + +#### Returns + +[`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "that iterates `eventName` events emitted by the `emitter`", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v13.6.0, v12.16.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[on](admin_discounts.internal.EventEmitter-1.mdx#on-1) + +___ + +### 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 + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Since + +v11.13.0, v10.16.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[once](admin_discounts.internal.EventEmitter-1.mdx#once-1) + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[once](admin_discounts.internal.EventEmitter-1.mdx#once-1) + +___ + +### 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 + + + +#### Returns + +`void` + + + +#### Since + +v15.4.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[setMaxListeners](admin_discounts.internal.EventEmitter-1.mdx#setmaxlisteners-1) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx new file mode 100644 index 0000000000..ba99ea4f4a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx @@ -0,0 +1,561 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AbstractBatchJobStrategy + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AbstractBatchJobStrategy + +## Implements + +- [`IBatchJobStrategy`](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx) + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "batchJobService_", + "type": "[`BatchJobService`](admin_discounts.internal.internal.BatchJobService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "batchType", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "identifier", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Implementation of + +IBatchJobStrategy.activeManager\_ + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Implementation of + +[IBatchJobStrategy](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx).[atomicPhase_](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx#atomicphase_) + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### buildTemplate + +▸ `Abstract` **buildTemplate**(): `Promise`<`string`\> + +Builds and returns a template file that can be downloaded and filled in + +#### Returns + +`Promise`<`string`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[IBatchJobStrategy](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx).[buildTemplate](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx#buildtemplate) + +___ + +### handleProcessingError + +▸ `Protected` **handleProcessingError**<`T`\>(`batchJobId`, `err`, `result`): `Promise`<`void`\> + + + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### preProcessBatchJob + +▸ **preProcessBatchJob**(`batchJobId`): `Promise`<`void`\> + +Method for pre-processing a batch job + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Implementation of + +[IBatchJobStrategy](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx).[preProcessBatchJob](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx#preprocessbatchjob) + +___ + +### prepareBatchJobForProcessing + +▸ **prepareBatchJobForProcessing**(`batchJob`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\> + +Method for preparing a batch job for processing + +#### Parameters + + + +#### Returns + +`Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "CreateBatchJobInput", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[IBatchJobStrategy](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx).[prepareBatchJobForProcessing](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx#preparebatchjobforprocessing) + +___ + +### processJob + +▸ `Abstract` **processJob**(`batchJobId`): `Promise`<`void`\> + +Method does the actual processing of the job. Should report back on the progress of the operation. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Implementation of + +[IBatchJobStrategy](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx).[processJob](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx#processjob) + +___ + +### shouldRetryOnProcessingError + +▸ `Protected` **shouldRetryOnProcessingError**(`batchJob`, `err`): `Promise`<`boolean`\> + +#### Parameters + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Implementation of + +[IBatchJobStrategy](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx).[shouldRetryTransaction_](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx#shouldretrytransaction_) + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AbstractBatchJobStrategy`](admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx) + +#### Parameters + + + +#### Returns + +[`AbstractBatchJobStrategy`](admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx) + + + +#### Implementation of + +[IBatchJobStrategy](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx).[withTransaction](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx#withtransaction) + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx new file mode 100644 index 0000000000..cde2ff96ee --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx @@ -0,0 +1,302 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AbstractCartCompletionStrategy + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AbstractCartCompletionStrategy + +## Implements + +- [`ICartCompletionStrategy`](../interfaces/admin_discounts.internal.internal.ICartCompletionStrategy.mdx) + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### complete + +▸ `Abstract` **complete**(`cartId`, `idempotencyKey`, `context`): `Promise`<[`CartCompletionResponse`](../modules/admin_discounts.internal.internal.mdx#cartcompletionresponse)\> + +Takes a cart id and completes the cart. This for example takes place when +creating an order or confirming a swap. + +#### Parameters + + + +#### Returns + +`Promise`<[`CartCompletionResponse`](../modules/admin_discounts.internal.internal.mdx#cartcompletionresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "the response for the completion request", + "children": [ + { + "name": "CartCompletionResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[ICartCompletionStrategy](../interfaces/admin_discounts.internal.internal.ICartCompletionStrategy.mdx).[complete](../interfaces/admin_discounts.internal.internal.ICartCompletionStrategy.mdx#complete) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AbstractCartCompletionStrategy`](admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx) + +#### Parameters + + + +#### Returns + +[`AbstractCartCompletionStrategy`](admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFileService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFileService.mdx new file mode 100644 index 0000000000..b841207b93 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFileService.mdx @@ -0,0 +1,537 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AbstractFileService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AbstractFileService + +## Implements + +- [`IFileService`](../interfaces/admin_discounts.internal.internal.IFileService.mdx) + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Implementation of + +IFileService.activeManager\_ + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Implementation of + +[IFileService](../interfaces/admin_discounts.internal.internal.IFileService.mdx).[atomicPhase_](../interfaces/admin_discounts.internal.internal.IFileService.mdx#atomicphase_) + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### delete + +▸ `Abstract` **delete**(`fileData`): `Promise`<`void`\> + +remove file from fileservice + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Implementation of + +[IFileService](../interfaces/admin_discounts.internal.internal.IFileService.mdx).[delete](../interfaces/admin_discounts.internal.internal.IFileService.mdx#delete) + +___ + +### getDownloadStream + +▸ `Abstract` **getDownloadStream**(`fileData`): `Promise`<[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx)\> + +download file from fileservice as stream + +#### Parameters + + + +#### Returns + +`Promise`<[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "readable stream of the file to download", + "children": [ + { + "name": "ReadableStream", + "type": "[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[IFileService](../interfaces/admin_discounts.internal.internal.IFileService.mdx).[getDownloadStream](../interfaces/admin_discounts.internal.internal.IFileService.mdx#getdownloadstream) + +___ + +### getPresignedDownloadUrl + +▸ `Abstract` **getPresignedDownloadUrl**(`fileData`): `Promise`<`string`\> + +Generate a presigned download url to obtain a file + +#### Parameters + + + +#### Returns + +`Promise`<`string`\> + +", + "optional": false, + "defaultValue": "", + "description": "presigned url to download the file", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[IFileService](../interfaces/admin_discounts.internal.internal.IFileService.mdx).[getPresignedDownloadUrl](../interfaces/admin_discounts.internal.internal.IFileService.mdx#getpresigneddownloadurl) + +___ + +### getUploadStreamDescriptor + +▸ `Abstract` **getUploadStreamDescriptor**(`fileData`): `Promise`<[`FileServiceGetUploadStreamResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileservicegetuploadstreamresult)\> + +upload file to fileservice from stream + +#### Parameters + + + +#### Returns + +`Promise`<[`FileServiceGetUploadStreamResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileservicegetuploadstreamresult)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "FileServiceGetUploadStreamResult", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[IFileService](../interfaces/admin_discounts.internal.internal.IFileService.mdx).[getUploadStreamDescriptor](../interfaces/admin_discounts.internal.internal.IFileService.mdx#getuploadstreamdescriptor) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Implementation of + +[IFileService](../interfaces/admin_discounts.internal.internal.IFileService.mdx).[shouldRetryTransaction_](../interfaces/admin_discounts.internal.internal.IFileService.mdx#shouldretrytransaction_) + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### upload + +▸ `Abstract` **upload**(`fileData`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> + +upload file to fileservice + +#### Parameters + + + +#### Returns + +`Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "FileServiceUploadResult", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[IFileService](../interfaces/admin_discounts.internal.internal.IFileService.mdx).[upload](../interfaces/admin_discounts.internal.internal.IFileService.mdx#upload) + +___ + +### uploadProtected + +▸ `Abstract` **uploadProtected**(`fileData`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> + +upload private file to fileservice + +#### Parameters + + + +#### Returns + +`Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "FileServiceUploadResult", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[IFileService](../interfaces/admin_discounts.internal.internal.IFileService.mdx).[uploadProtected](../interfaces/admin_discounts.internal.internal.IFileService.mdx#uploadprotected) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AbstractFileService`](admin_discounts.internal.internal.AbstractFileService.mdx) + +#### Parameters + + + +#### Returns + +[`AbstractFileService`](admin_discounts.internal.internal.AbstractFileService.mdx) + + + +#### Implementation of + +[IFileService](../interfaces/admin_discounts.internal.internal.IFileService.mdx).[withTransaction](../interfaces/admin_discounts.internal.internal.IFileService.mdx#withtransaction) + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFulfillmentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFulfillmentService.mdx new file mode 100644 index 0000000000..9e5f6a43a7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFulfillmentService.mdx @@ -0,0 +1,765 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AbstractFulfillmentService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AbstractFulfillmentService + +Fulfillment Provider interface +Fullfillment provider plugin services should extend the AbstractFulfillmentService from this file + +## Implements + +- [`FulfillmentService`](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx) + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "container", + "type": "[`MedusaContainer`](../../admin_discounts/modules/admin_discounts.internal.mdx#medusacontainer)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "identifier", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### calculatePrice + +▸ `Abstract` **calculatePrice**(`optionData`, `data`, `cart`): `Promise`<`number`\> + +Used to calculate a price for a given shipping option. + +#### Parameters + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx).[calculatePrice](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx#calculateprice) + +___ + +### canCalculate + +▸ `Abstract` **canCalculate**(`data`): `Promise`<`boolean`\> + +Used to determine if a shipping option can have a calculated price + +#### Parameters + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx).[canCalculate](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx#cancalculate) + +___ + +### cancelFulfillment + +▸ `Abstract` **cancelFulfillment**(`fulfillment`): `Promise`<`any`\> + +Cancel a fulfillment using data from the fulfillment + +#### Parameters + + + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx).[cancelFulfillment](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx#cancelfulfillment) + +___ + +### createFulfillment + +▸ `Abstract` **createFulfillment**(`data`, `items`, `order`, `fulfillment`): `Promise`<[`FulfillmentProviderData`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +`Promise`<[`FulfillmentProviderData`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentproviderdata)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "FulfillmentProviderData", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx).[createFulfillment](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx#createfulfillment) + +___ + +### createReturn + +▸ `Abstract` **createReturn**(`returnOrder`): `Promise`\> + +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 + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Implementation of + +[FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx).[createReturn](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx#createreturn) + +___ + +### getFulfillmentDocuments + +▸ `Abstract` **getFulfillmentDocuments**(`data`): `Promise`<`any`\> + +Used to retrieve documents associated with a fulfillment. + +#### Parameters + + + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx).[getFulfillmentDocuments](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx#getfulfillmentdocuments) + +___ + +### 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`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Implementation of + +[FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx).[getFulfillmentOptions](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx#getfulfillmentoptions) + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +Return a unique identifier to retrieve the fulfillment plugin provider + +#### Returns + +`string` + + + +#### Implementation of + +[FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx).[getIdentifier](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx#getidentifier) + +___ + +### getReturnDocuments + +▸ `Abstract` **getReturnDocuments**(`data`): `Promise`<`any`\> + +Used to retrieve documents related to a return order. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx).[getReturnDocuments](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx#getreturndocuments) + +___ + +### getShipmentDocuments + +▸ `Abstract` **getShipmentDocuments**(`data`): `Promise`<`any`\> + +Used to retrieve documents related to a shipment. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx).[getShipmentDocuments](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx#getshipmentdocuments) + +___ + +### retrieveDocuments + +▸ `Abstract` **retrieveDocuments**(`fulfillmentData`, `documentType`): `Promise`<`any`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "documentType", + "type": "``\"label\"`` \\| ``\"invoice\"``", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx).[retrieveDocuments](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx#retrievedocuments) + +___ + +### validateFulfillmentData + +▸ `Abstract` **validateFulfillmentData**(`optionData`, `data`, `cart`): `Promise`\> + +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 + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "the data to populate `cart.shipping_methods.$.data` this\n is usually important for future actions like generating shipping labels", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Implementation of + +[FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx).[validateFulfillmentData](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx#validatefulfillmentdata) + +___ + +### 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 + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx).[validateOption](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx#validateoption) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractNotificationService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractNotificationService.mdx new file mode 100644 index 0000000000..b39aedec07 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractNotificationService.mdx @@ -0,0 +1,407 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AbstractNotificationService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AbstractNotificationService + +## Implements + +- [`INotificationService`](../interfaces/admin_discounts.internal.internal.INotificationService.mdx) + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "identifier", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Implementation of + +INotificationService.activeManager\_ + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Implementation of + +[INotificationService](../interfaces/admin_discounts.internal.internal.INotificationService.mdx).[atomicPhase_](../interfaces/admin_discounts.internal.internal.INotificationService.mdx#atomicphase_) + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +#### Returns + +`string` + + + +___ + +### resendNotification + +▸ `Abstract` **resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReturnedData", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[INotificationService](../interfaces/admin_discounts.internal.internal.INotificationService.mdx).[resendNotification](../interfaces/admin_discounts.internal.internal.INotificationService.mdx#resendnotification) + +___ + +### sendNotification + +▸ `Abstract` **sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReturnedData", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[INotificationService](../interfaces/admin_discounts.internal.internal.INotificationService.mdx).[sendNotification](../interfaces/admin_discounts.internal.internal.INotificationService.mdx#sendnotification) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Implementation of + +[INotificationService](../interfaces/admin_discounts.internal.internal.INotificationService.mdx).[shouldRetryTransaction_](../interfaces/admin_discounts.internal.internal.INotificationService.mdx#shouldretrytransaction_) + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AbstractNotificationService`](admin_discounts.internal.internal.AbstractNotificationService.mdx) + +#### Parameters + + + +#### Returns + +[`AbstractNotificationService`](admin_discounts.internal.internal.AbstractNotificationService.mdx) + + + +#### Implementation of + +[INotificationService](../interfaces/admin_discounts.internal.internal.INotificationService.mdx).[withTransaction](../interfaces/admin_discounts.internal.internal.INotificationService.mdx#withtransaction) + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentProcessor.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentProcessor.mdx new file mode 100644 index 0000000000..82707a87d4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentProcessor.mdx @@ -0,0 +1,617 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AbstractPaymentProcessor + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AbstractPaymentProcessor + +Payment processor in charge of creating , managing and processing a payment + +## Implements + +- [`PaymentProcessor`](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx) + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "container", + "type": "[`MedusaContainer`](../../admin_discounts/modules/admin_discounts.internal.mdx#medusacontainer-1)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "identifier", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### authorizePayment + +▸ `Abstract` **authorizePayment**(`paymentSessionData`, `context`): `Promise`<[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| { `data`: Record<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> + +Authorize an existing session if it is not already authorized + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| { `data`: Record<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> + + ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PaymentProcessorError \\| { `data`: Record<`string`, `unknown`\\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }", + "type": "[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \\| { `data`: Record<`string`, `unknown`\\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[PaymentProcessor](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx).[authorizePayment](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx#authorizepayment) + +___ + +### cancelPayment + +▸ `Abstract` **cancelPayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + +Cancel an existing session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + + \\| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record \\| PaymentProcessorError", + "type": "Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[PaymentProcessor](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx).[cancelPayment](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx#cancelpayment) + +___ + +### capturePayment + +▸ `Abstract` **capturePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + +Capture an existing session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + + \\| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record \\| PaymentProcessorError", + "type": "Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[PaymentProcessor](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx).[capturePayment](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx#capturepayment) + +___ + +### deletePayment + +▸ `Abstract` **deletePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + +Delete an existing session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + + \\| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record \\| PaymentProcessorError", + "type": "Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[PaymentProcessor](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx).[deletePayment](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx#deletepayment) + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +Return a unique identifier to retrieve the payment plugin provider + +#### Returns + +`string` + + + +#### Implementation of + +[PaymentProcessor](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx).[getIdentifier](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx#getidentifier) + +___ + +### getPaymentStatus + +▸ `Abstract` **getPaymentStatus**(`paymentSessionData`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> + +Return the status of the session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AUTHORIZED", + "type": "``\"authorized\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "ERROR", + "type": "``\"error\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_MORE", + "type": "``\"requires_more\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[PaymentProcessor](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx).[getPaymentStatus](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx#getpaymentstatus) + +___ + +### initiatePayment + +▸ `Abstract` **initiatePayment**(`context`): `Promise`<[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> + +Initiate a payment session with the external provider + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PaymentProcessorError \\| PaymentProcessorSessionResponse", + "type": "[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \\| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[PaymentProcessor](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx).[initiatePayment](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx#initiatepayment) + +___ + +### refundPayment + +▸ `Abstract` **refundPayment**(`paymentSessionData`, `refundAmount`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + +Refund an existing session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundAmount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + + \\| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record \\| PaymentProcessorError", + "type": "Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[PaymentProcessor](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx).[refundPayment](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx#refundpayment) + +___ + +### retrievePayment + +▸ `Abstract` **retrievePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + +Retrieve an existing session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + + \\| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record \\| PaymentProcessorError", + "type": "Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[PaymentProcessor](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx).[retrievePayment](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx#retrievepayment) + +___ + +### updatePayment + +▸ `Abstract` **updatePayment**(`context`): `Promise`<`void` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> + +Update an existing payment session + +#### Parameters + + + +#### Returns + +`Promise`<`void` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "void \\| PaymentProcessorError \\| PaymentProcessorSessionResponse", + "type": "`void` \\| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \\| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[PaymentProcessor](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx).[updatePayment](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx#updatepayment) + +___ + +### updatePaymentData + +▸ `Abstract` **updatePaymentData**(`sessionId`, `data`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + +Update the session data for a payment session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + + \\| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record \\| PaymentProcessorError", + "type": "Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[PaymentProcessor](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx).[updatePaymentData](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx#updatepaymentdata) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentService.mdx new file mode 100644 index 0000000000..b1e9a28b5e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentService.mdx @@ -0,0 +1,1069 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AbstractPaymentService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AbstractPaymentService + +This will be + +#### Deprecated + +in the near future use the AbstractPaymentProcessor instead + +## Implements + +- [`PaymentService`](../interfaces/admin_discounts.internal.internal.PaymentService.mdx) + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "identifier", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Implementation of + +PaymentService.activeManager\_ + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[atomicPhase_](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#atomicphase_) + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### authorizePayment + +▸ `Abstract` **authorizePayment**(`paymentSession`, `context`): `Promise`<{ `data`: [`Data`](../modules/admin_discounts.internal.internal.mdx#data) ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> + +#### Parameters + + + +#### Returns + +`Promise`<{ `data`: [`Data`](../modules/admin_discounts.internal.internal.mdx#data) ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "`object`", + "type": "`object`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[authorizePayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#authorizepayment) + +___ + +### cancelPayment + +▸ `Abstract` **cancelPayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[cancelPayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#cancelpayment) + +___ + +### capturePayment + +▸ `Abstract` **capturePayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[capturePayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#capturepayment) + +___ + +### createPayment + +▸ `Abstract` **createPayment**(`context`): `Promise`<[`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PaymentSessionResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[createPayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#createpayment) + +▸ `Abstract` **createPayment**(`cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future use `createPayment(context: Cart & PaymentContext): Promise` instead + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[createPayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#createpayment) + +___ + +### deletePayment + +▸ `Abstract` **deletePayment**(`paymentSession`): `Promise`<`void`\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Deprecated + +in the near future + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[deletePayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#deletepayment) + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +#### Returns + +`string` + + + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[getIdentifier](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#getidentifier) + +___ + +### getPaymentData + +▸ `Abstract` **getPaymentData**(`paymentSession`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[getPaymentData](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#getpaymentdata) + +___ + +### getStatus + +▸ `Abstract` **getStatus**(`data`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AUTHORIZED", + "type": "``\"authorized\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "ERROR", + "type": "``\"error\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_MORE", + "type": "``\"requires_more\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[getStatus](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#getstatus) + +___ + +### refundPayment + +▸ `Abstract` **refundPayment**(`payment`, `refundAmount`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[refundPayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#refundpayment) + +___ + +### retrievePayment + +▸ `Abstract` **retrievePayment**(`paymentData`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[retrievePayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#retrievepayment) + +___ + +### retrieveSavedMethods + +▸ **retrieveSavedMethods**(`customer`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data[]", + "type": "[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Deprecated + +in the near future + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[retrieveSavedMethods](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#retrievesavedmethods) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[shouldRetryTransaction_](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#shouldretrytransaction_) + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### updatePayment + +▸ `Abstract` **updatePayment**(`paymentSessionData`, `context`): `Promise` \| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> + +#### Parameters + + + +#### Returns + +`Promise` \| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> + + \\| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\\>", + "optional": false, + "defaultValue": "", + "description": "it return either a PaymentSessionResponse or PaymentSessionResponse[\"session_data\"] to maintain backward compatibility", + "children": [ + { + "name": "Record \\| PaymentSessionResponse", + "type": "Record<`string`, `unknown`\\> \\| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[updatePayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#updatepayment) + +▸ `Abstract` **updatePayment**(`paymentSessionData`, `cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future use `updatePayment(paymentSessionData: PaymentSessionData, context: Cart & PaymentContext): Promise` instead + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[updatePayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#updatepayment) + +___ + +### updatePaymentData + +▸ `Abstract` **updatePaymentData**(`paymentSessionData`, `data`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[updatePaymentData](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#updatepaymentdata) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx) + +#### Parameters + + + +#### Returns + +[`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx) + + + +#### Implementation of + +[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[withTransaction](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#withtransaction) + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx new file mode 100644 index 0000000000..58d2c802d7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx @@ -0,0 +1,355 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AbstractPriceSelectionStrategy + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AbstractPriceSelectionStrategy + +## Implements + +- [`IPriceSelectionStrategy`](../interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx) + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### calculateVariantPrice + +▸ `Abstract` **calculateVariantPrice**(`data`, `context`): `Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\>\> + +Calculate the original and discount price for a given variant in a set of +circumstances described in the context. + +#### Parameters + + + +#### Returns + +`Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "pricing details in an object containing the calculated lowest price,\nthe default price an all valid prices for the given variant", + "children": [ + { + "name": "Map", + "type": "`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "PriceSelectionResult", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Implementation of + +[IPriceSelectionStrategy](../interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx).[calculateVariantPrice](../interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx#calculatevariantprice) + +___ + +### onVariantsPricesUpdate + +▸ **onVariantsPricesUpdate**(`variantIds`): `Promise`<`void`\> + +Notify price selection strategy that variants prices have been updated. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Implementation of + +[IPriceSelectionStrategy](../interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx).[onVariantsPricesUpdate](../interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx#onvariantspricesupdate) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AbstractPriceSelectionStrategy`](admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx) + +#### Parameters + + + +#### Returns + +[`AbstractPriceSelectionStrategy`](admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx) + + + +#### Implementation of + +[IPriceSelectionStrategy](../interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx).[withTransaction](../interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx#withtransaction) + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractTaxService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractTaxService.mdx new file mode 100644 index 0000000000..f734ac4291 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractTaxService.mdx @@ -0,0 +1,125 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AbstractTaxService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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. + +## Implements + +- [`ITaxService`](../interfaces/admin_discounts.internal.internal.ITaxService.mdx) + +## Properties + + + +## Methods + +### getIdentifier + +▸ **getIdentifier**(): `string` + +#### Returns + +`string` + + + +___ + +### getTaxLines + +▸ `Abstract` **getTaxLines**(`itemLines`, `shippingLines`, `context`): `Promise`<[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]\> + +Retrieves the numerical tax lines for a calculation context. + +#### Parameters + + + +#### Returns + +`Promise`<[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "numerical tax rates that should apply to the provided calculation\n lines", + "children": [ + { + "name": "ProviderTaxLine[]", + "type": "[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProviderTaxLine", + "type": "[`ProviderLineItemTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providerlineitemtaxline) \\| [`ProviderShippingMethodTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providershippingmethodtaxline)", + "description": "A union type of the possible provider tax lines.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Implementation of + +[ITaxService](../interfaces/admin_discounts.internal.internal.ITaxService.mdx).[getTaxLines](../interfaces/admin_discounts.internal.internal.ITaxService.mdx#gettaxlines) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx new file mode 100644 index 0000000000..f826f1d9ff --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx @@ -0,0 +1,58 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminCreateUserRequest + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminCreateUserRequest + +#### Schema + +The User's email. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.mdx new file mode 100644 index 0000000000..e16dc820e7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteDiscountsDiscountConditionsConditionBatchParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminDeleteDiscountsDiscountConditionsConditionBatchParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.mdx new file mode 100644 index 0000000000..0dfebcd839 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteDiscountsDiscountConditionsConditionParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminDeleteDiscountsDiscountConditionsConditionParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeletePriceListPricesPricesReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeletePriceListPricesPricesReq.mdx new file mode 100644 index 0000000000..d66d65ec55 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeletePriceListPricesPricesReq.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeletePriceListPricesPricesReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminDeletePriceListPricesPricesReq + +#### Schema + +AdminDeletePriceListPricesPricesReq +type: object +properties: + price_ids: + description: The price IDs of the Money Amounts to delete. + type: array + items: + type: string + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.mdx new file mode 100644 index 0000000000..df50e224e4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeletePriceListsPriceListProductsPricesBatchReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.mdx new file mode 100644 index 0000000000..e8781ca09e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteProductCategoriesCategoryProductsBatchParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminDeleteProductCategoriesCategoryProductsBatchParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.mdx new file mode 100644 index 0000000000..edae378a08 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.mdx @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteProductCategoriesCategoryProductsBatchReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.mdx new file mode 100644 index 0000000000..1cfe3ee221 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.mdx @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeletePublishableApiKeySalesChannelsBatchReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.mdx new file mode 100644 index 0000000000..0afa1ce52d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.mdx @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteSalesChannelsChannelProductsBatchReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.mdx new file mode 100644 index 0000000000..7f2d6894e3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteSalesChannelsChannelStockLocationsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminDeleteSalesChannelsChannelStockLocationsReq + +#### Schema + +AdminDeleteSalesChannelsChannelStockLocationsReq +type: object +required: + - location_id +properties: + location_id: + description: The ID of the stock location + type: string + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.mdx new file mode 100644 index 0000000000..3c15260427 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteTaxRatesTaxRateProductTypesParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminDeleteTaxRatesTaxRateProductTypesParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.mdx new file mode 100644 index 0000000000..ae9b5b529f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteTaxRatesTaxRateProductTypesReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminDeleteTaxRatesTaxRateProductTypesReq + +#### Schema + +The IDs of the product types to remove their association with this tax rate. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductsParams.mdx new file mode 100644 index 0000000000..e78864afb8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteTaxRatesTaxRateProductsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminDeleteTaxRatesTaxRateProductsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductsReq.mdx new file mode 100644 index 0000000000..6933488d47 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductsReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteTaxRatesTaxRateProductsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminDeleteTaxRatesTaxRateProductsReq + +#### Schema + +The IDs of the products to remove their association with this tax rate. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.mdx new file mode 100644 index 0000000000..8b94f473e3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteTaxRatesTaxRateShippingOptionsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminDeleteTaxRatesTaxRateShippingOptionsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.mdx new file mode 100644 index 0000000000..6167e4562f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteTaxRatesTaxRateShippingOptionsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminDeleteTaxRatesTaxRateShippingOptionsReq + +#### Schema + +The IDs of the shipping options to remove their association with this tax rate. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteUploadsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteUploadsReq.mdx new file mode 100644 index 0000000000..04e9def1ec --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminDeleteUploadsReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminDeleteUploadsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminDeleteUploadsReq + +#### Schema + +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. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetDiscountParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetDiscountParams.mdx new file mode 100644 index 0000000000..445ecb898b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetDiscountParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetDiscountParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetDiscountParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetDiscountsDiscountCodeParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetDiscountsDiscountCodeParams.mdx new file mode 100644 index 0000000000..4ef0e0c1f2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetDiscountsDiscountCodeParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetDiscountsDiscountCodeParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetDiscountsDiscountCodeParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetDraftOrdersParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetDraftOrdersParams.mdx new file mode 100644 index 0000000000..73fa4c9554 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetDraftOrdersParams.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetDraftOrdersParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetDraftOrdersParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetGiftCardsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetGiftCardsParams.mdx new file mode 100644 index 0000000000..b0049564e4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetGiftCardsParams.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetGiftCardsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetGiftCardsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetInventoryItemsItemLocationLevelsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetInventoryItemsItemLocationLevelsParams.mdx new file mode 100644 index 0000000000..bcabee666f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetInventoryItemsItemLocationLevelsParams.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetInventoryItemsItemLocationLevelsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetInventoryItemsItemLocationLevelsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetInventoryItemsItemParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetInventoryItemsItemParams.mdx new file mode 100644 index 0000000000..2d19cded8a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetInventoryItemsItemParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetInventoryItemsItemParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetInventoryItemsItemParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetInventoryItemsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetInventoryItemsParams.mdx new file mode 100644 index 0000000000..326955b4e7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetInventoryItemsParams.mdx @@ -0,0 +1,150 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetInventoryItemsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetInventoryItemsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetNotesParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetNotesParams.mdx new file mode 100644 index 0000000000..aa66dd8e15 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetNotesParams.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetNotesParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetNotesParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetNotificationsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetNotificationsParams.mdx new file mode 100644 index 0000000000..eb6f2317fa --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetNotificationsParams.mdx @@ -0,0 +1,86 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetNotificationsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetNotificationsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetOrdersOrderParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetOrdersOrderParams.mdx new file mode 100644 index 0000000000..4545a5868a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetOrdersOrderParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetOrdersOrderParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetOrdersOrderParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetOrdersParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetOrdersParams.mdx new file mode 100644 index 0000000000..d5b4998f0c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetOrdersParams.mdx @@ -0,0 +1,174 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetOrdersParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetOrdersParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetPaymentCollectionsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetPaymentCollectionsParams.mdx new file mode 100644 index 0000000000..9a5467a7ba --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetPaymentCollectionsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetPaymentCollectionsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetPaymentCollectionsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetPriceListPaginationParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetPriceListPaginationParams.mdx new file mode 100644 index 0000000000..8bd8fbadbb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetPriceListPaginationParams.mdx @@ -0,0 +1,126 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetPriceListPaginationParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetPriceListPaginationParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetPriceListsPriceListProductsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetPriceListsPriceListProductsParams.mdx new file mode 100644 index 0000000000..d45ccec0c8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetPriceListsPriceListProductsParams.mdx @@ -0,0 +1,158 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetPriceListsPriceListProductsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetPriceListsPriceListProductsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductCategoriesParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductCategoriesParams.mdx new file mode 100644 index 0000000000..5bb013d783 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductCategoriesParams.mdx @@ -0,0 +1,94 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetProductCategoriesParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetProductCategoriesParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductCategoryParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductCategoryParams.mdx new file mode 100644 index 0000000000..ca32941d8d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductCategoryParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetProductCategoryParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetProductCategoryParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductTagsPaginationParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductTagsPaginationParams.mdx new file mode 100644 index 0000000000..d5d73041b5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductTagsPaginationParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetProductTagsPaginationParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetProductTagsPaginationParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductTagsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductTagsParams.mdx new file mode 100644 index 0000000000..4131028fcb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductTagsParams.mdx @@ -0,0 +1,86 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetProductTagsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetProductTagsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductTypesParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductTypesParams.mdx new file mode 100644 index 0000000000..bc181d69a9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductTypesParams.mdx @@ -0,0 +1,86 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetProductTypesParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetProductTypesParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductsParams.mdx new file mode 100644 index 0000000000..6a85951496 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductsParams.mdx @@ -0,0 +1,200 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetProductsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetProductsParams + +API Level DTOs + Validation rules + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductsVariantsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductsVariantsParams.mdx new file mode 100644 index 0000000000..d20bda2a9d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetProductsVariantsParams.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetProductsVariantsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetProductsVariantsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetRegionsPaginationParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetRegionsPaginationParams.mdx new file mode 100644 index 0000000000..c14ab0d4b9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetRegionsPaginationParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetRegionsPaginationParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetRegionsPaginationParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetRegionsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetRegionsParams.mdx new file mode 100644 index 0000000000..abf71dea0f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetRegionsParams.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetRegionsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetRegionsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetRegionsRegionFulfillmentOptionsRes.mdx similarity index 56% rename from www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md rename to www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetRegionsRegionFulfillmentOptionsRes.mdx index ab5021b041..5e62b87e75 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetRegionsRegionFulfillmentOptionsRes.mdx @@ -2,11 +2,13 @@ displayed_sidebar: jsClientSidebar --- -# Class: AdminGetRegionsRegionFulfillmentOptionsRes +import ParameterTypes from "@site/src/components/ParameterTypes" -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetRegionsRegionFulfillmentOptionsRes +# AdminGetRegionsRegionFulfillmentOptionsRes -**`Schema`** +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetRegionsRegionFulfillmentOptionsRes + +#### Schema AdminGetRegionsRegionFulfillmentOptionsRes type: object @@ -37,10 +39,13 @@ properties: ## 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/internal/classes/admin_discounts.internal.internal.AdminGetReservationsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetReservationsParams.mdx new file mode 100644 index 0000000000..0954e17029 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetReservationsParams.mdx @@ -0,0 +1,102 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetReservationsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetReservationsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetReturnsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetReturnsParams.mdx new file mode 100644 index 0000000000..594164b33a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetReturnsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetReturnsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetReturnsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetSalesChannelsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetSalesChannelsParams.mdx new file mode 100644 index 0000000000..1664fde28f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetSalesChannelsParams.mdx @@ -0,0 +1,110 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetSalesChannelsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetSalesChannelsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetShippingOptionsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetShippingOptionsParams.mdx new file mode 100644 index 0000000000..7c7b80bada --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetShippingOptionsParams.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetShippingOptionsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetShippingOptionsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetStockLocationsLocationParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetStockLocationsLocationParams.mdx new file mode 100644 index 0000000000..8069882549 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetStockLocationsLocationParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetStockLocationsLocationParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetStockLocationsLocationParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetStockLocationsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetStockLocationsParams.mdx new file mode 100644 index 0000000000..f66553f193 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetStockLocationsParams.mdx @@ -0,0 +1,78 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetStockLocationsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetStockLocationsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetSwapsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetSwapsParams.mdx new file mode 100644 index 0000000000..b93ddd56b7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetSwapsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetSwapsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetSwapsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetTaxRatesParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetTaxRatesParams.mdx new file mode 100644 index 0000000000..a4c529e6e3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetTaxRatesParams.mdx @@ -0,0 +1,78 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetTaxRatesParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetTaxRatesParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetTaxRatesTaxRateParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetTaxRatesTaxRateParams.mdx new file mode 100644 index 0000000000..857cb68de0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetTaxRatesTaxRateParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetTaxRatesTaxRateParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetTaxRatesTaxRateParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetVariantParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetVariantParams.mdx new file mode 100644 index 0000000000..9a048400df --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetVariantParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetVariantParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetVariantParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetVariantsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetVariantsParams.mdx new file mode 100644 index 0000000000..b57d9f67af --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminGetVariantsParams.mdx @@ -0,0 +1,110 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminGetVariantsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminGetVariantsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostAnalyticsConfigAnalyticsConfigReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostAnalyticsConfigAnalyticsConfigReq.mdx new file mode 100644 index 0000000000..7356fa0a4b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostAnalyticsConfigAnalyticsConfigReq.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostAnalyticsConfigAnalyticsConfigReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostAnalyticsConfigAnalyticsConfigReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostAnalyticsConfigReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostAnalyticsConfigReq.mdx new file mode 100644 index 0000000000..1c2303bc85 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostAnalyticsConfigReq.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostAnalyticsConfigReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostAnalyticsConfigReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDiscountsDiscountParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDiscountsDiscountParams.mdx new file mode 100644 index 0000000000..84463ccf5e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDiscountsDiscountParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDiscountsDiscountParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostDiscountsDiscountParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDiscountsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDiscountsParams.mdx new file mode 100644 index 0000000000..2430dae7fc --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDiscountsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDiscountsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostDiscountsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.mdx new file mode 100644 index 0000000000..241dc251d5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.mdx @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDraftOrdersDraftOrderLineItemsItemReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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`Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.mdx new file mode 100644 index 0000000000..66a24e5f6b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDraftOrdersDraftOrderLineItemsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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`Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderReq.mdx new file mode 100644 index 0000000000..1c7545fab7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderReq.mdx @@ -0,0 +1,82 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDraftOrdersDraftOrderReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostDraftOrdersDraftOrderReq + +#### Schema + +The 2 character ISO code for the Country. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersReq.mdx new file mode 100644 index 0000000000..2a0faac854 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostDraftOrdersReq.mdx @@ -0,0 +1,120 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostDraftOrdersReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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`The email of the customer of the draft order`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`Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "`string` \\| [`AddressPayload`](addresses.internal.AddressPayload.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](admin_discounts.internal.ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostGiftCardsGiftCardReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostGiftCardsGiftCardReq.mdx new file mode 100644 index 0000000000..451ed67839 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostGiftCardsGiftCardReq.mdx @@ -0,0 +1,66 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostGiftCardsGiftCardReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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`Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostGiftCardsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostGiftCardsReq.mdx new file mode 100644 index 0000000000..a48ae8d86c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostGiftCardsReq.mdx @@ -0,0 +1,68 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostGiftCardsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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`Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsInventoryItemParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsInventoryItemParams.mdx new file mode 100644 index 0000000000..876b0ca5dd --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsInventoryItemParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostInventoryItemsInventoryItemParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostInventoryItemsInventoryItemParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsInventoryItemReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsInventoryItemReq.mdx new file mode 100644 index 0000000000..520f362844 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsInventoryItemReq.mdx @@ -0,0 +1,151 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostInventoryItemsInventoryItemReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.mdx new file mode 100644 index 0000000000..785848e372 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostInventoryItemsItemLocationLevelsLevelParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostInventoryItemsItemLocationLevelsLevelParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.mdx new file mode 100644 index 0000000000..c2d2657d82 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.mdx @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostInventoryItemsItemLocationLevelsLevelReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsParams.mdx new file mode 100644 index 0000000000..791298805f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostInventoryItemsItemLocationLevelsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostInventoryItemsItemLocationLevelsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsReq.mdx new file mode 100644 index 0000000000..02724aca25 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsReq.mdx @@ -0,0 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostInventoryItemsItemLocationLevelsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsParams.mdx new file mode 100644 index 0000000000..fb350e9b95 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostInventoryItemsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostInventoryItemsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsReq.mdx new file mode 100644 index 0000000000..d3bef815be --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInventoryItemsReq.mdx @@ -0,0 +1,130 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostInventoryItemsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostInventoryItemsReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInvitesInviteAcceptReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInvitesInviteAcceptReq.mdx new file mode 100644 index 0000000000..d27b90ecc2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInvitesInviteAcceptReq.mdx @@ -0,0 +1,34 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostInvitesInviteAcceptReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostInvitesInviteAcceptReq + +#### Schema + +The token of the invite to accept. This is a unique token generated when the invite was created or resent. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInvitesInviteAcceptUserReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInvitesInviteAcceptUserReq.mdx new file mode 100644 index 0000000000..e512be9f78 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInvitesInviteAcceptUserReq.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostInvitesInviteAcceptUserReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostInvitesInviteAcceptUserReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInvitesReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInvitesReq.mdx new file mode 100644 index 0000000000..d1fe482411 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostInvitesReq.mdx @@ -0,0 +1,34 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostInvitesReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostInvitesReq + +#### Schema + +The email associated with the invite. Once the invite is accepted, the email will be associated with the created user. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostNotesNoteReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostNotesNoteReq.mdx new file mode 100644 index 0000000000..8414c24c63 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostNotesNoteReq.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostNotesNoteReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostNotesNoteReq + +#### Schema + +AdminPostNotesNoteReq +type: object +required: + - value +properties: + value: + type: string + description: The description of the Note. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostNotesReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostNotesReq.mdx new file mode 100644 index 0000000000..84b4d8a595 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostNotesReq.mdx @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostNotesReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostNotificationsNotificationResendReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostNotificationsNotificationResendReq.mdx new file mode 100644 index 0000000000..8117b90260 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostNotificationsNotificationResendReq.mdx @@ -0,0 +1,31 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostNotificationsNotificationResendReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsEditLineItemsLineItemReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsEditLineItemsLineItemReq.mdx new file mode 100644 index 0000000000..0c43fee7a0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsEditLineItemsLineItemReq.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrderEditsEditLineItemsLineItemReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrderEditsEditLineItemsLineItemReq + +#### Schema + +AdminPostOrderEditsEditLineItemsLineItemReq +type: object +required: + - quantity +properties: + quantity: + description: The quantity to update + type: number + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsEditLineItemsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsEditLineItemsReq.mdx new file mode 100644 index 0000000000..d224828363 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsEditLineItemsReq.mdx @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrderEditsEditLineItemsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrderEditsEditLineItemsReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsOrderEditReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsOrderEditReq.mdx new file mode 100644 index 0000000000..9c14b0145d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsOrderEditReq.mdx @@ -0,0 +1,31 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrderEditsOrderEditReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrderEditsOrderEditReq + +#### Schema + +AdminPostOrderEditsOrderEditReq +type: object +properties: + internal_note: + description: An optional note to create or update in the order edit. + type: string + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsReq.mdx new file mode 100644 index 0000000000..f5ad728079 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsReq.mdx @@ -0,0 +1,52 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrderEditsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsRequestConfirmationReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsRequestConfirmationReq.mdx new file mode 100644 index 0000000000..514ef9ddf4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrderEditsRequestConfirmationReq.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrderEditsRequestConfirmationReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrderEditsRequestConfirmationReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersClaimCancel.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersClaimCancel.mdx new file mode 100644 index 0000000000..5f0e6db3c0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersClaimCancel.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersClaimCancel + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersClaimCancel + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersClaimFulfillmentsCancelParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersClaimFulfillmentsCancelParams.mdx new file mode 100644 index 0000000000..7c7272d702 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersClaimFulfillmentsCancelParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersClaimFulfillmentsCancelParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersClaimFulfillmentsCancelParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderArchiveParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderArchiveParams.mdx new file mode 100644 index 0000000000..0dd12ab5c2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderArchiveParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderArchiveParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderArchiveParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderCancel.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderCancel.mdx new file mode 100644 index 0000000000..8114882ed7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderCancel.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderCancel + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderCancel + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderCaptureParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderCaptureParams.mdx new file mode 100644 index 0000000000..9a701b33d4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderCaptureParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderCaptureParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderCaptureParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.mdx new file mode 100644 index 0000000000..87a4ac5d4a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderClaimsClaimFulfillmentsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderClaimsClaimFulfillmentsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.mdx new file mode 100644 index 0000000000..5f2457d3c5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderClaimsClaimFulfillmentsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderClaimsClaimFulfillmentsReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it.`true`, no notification will be sent to the customer related to this Claim. + type: boolean + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimParams.mdx new file mode 100644 index 0000000000..ac667cf1cb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderClaimsClaimParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderClaimsClaimParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimReq.mdx new file mode 100644 index 0000000000..5b06401cd6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimReq.mdx @@ -0,0 +1,50 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderClaimsClaimReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderClaimsClaimReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](admin_discounts.internal.ShippingMethod-2.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.mdx new file mode 100644 index 0000000000..98164a3026 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderClaimsClaimShipmentsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderClaimsClaimShipmentsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.mdx new file mode 100644 index 0000000000..8842266e27 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderClaimsClaimShipmentsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsParams.mdx new file mode 100644 index 0000000000..a245d154df --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderClaimsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderClaimsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsReq.mdx new file mode 100644 index 0000000000..d408d588c1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsReq.mdx @@ -0,0 +1,171 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderClaimsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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`An optional shipping address to send the claimed items to. If not provided, the parent order's shipping address will be used.`refund`Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "return_location_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "return_shipping", + "type": "[`ReturnShipping`](admin_discounts.internal.ReturnShipping.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`AddressPayload`](addresses.internal.AddressPayload.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](admin_discounts.internal.ShippingMethod-1.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "``\"refund\"`` \\| ``\"replace\"``", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderCompleteParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderCompleteParams.mdx new file mode 100644 index 0000000000..f0859a21fe --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderCompleteParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderCompleteParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderCompleteParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillementsCancelParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillementsCancelParams.mdx new file mode 100644 index 0000000000..789a6569f1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillementsCancelParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderFulfillementsCancelParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderFulfillementsCancelParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillmentsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillmentsParams.mdx new file mode 100644 index 0000000000..f8104161e7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillmentsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderFulfillmentsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderFulfillmentsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillmentsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillmentsReq.mdx new file mode 100644 index 0000000000..34027c06ae --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillmentsReq.mdx @@ -0,0 +1,71 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderFulfillmentsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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`Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderParams.mdx new file mode 100644 index 0000000000..cb7abd8b66 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderRefundsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderRefundsParams.mdx new file mode 100644 index 0000000000..18289c720c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderRefundsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderRefundsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderRefundsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderRefundsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderRefundsReq.mdx new file mode 100644 index 0000000000..1530842c6a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderRefundsReq.mdx @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderRefundsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderReq.mdx new file mode 100644 index 0000000000..fc0f2fa2ae --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderReq.mdx @@ -0,0 +1,159 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + +[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "Record<`string`, `unknown`\\>[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_method", + "type": "[`PaymentMethod`](admin_discounts.internal.PaymentMethod.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`AddressPayload`](addresses.internal.AddressPayload.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](admin_discounts.internal.ShippingMethod-3.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderReturnsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderReturnsParams.mdx new file mode 100644 index 0000000000..8a620818c3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderReturnsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderReturnsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderReturnsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReturnsReq.md b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderReturnsReq.mdx similarity index 51% rename from www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReturnsReq.md rename to www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderReturnsReq.mdx index f47a9c7f0c..382ec21c28 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReturnsReq.md +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderReturnsReq.mdx @@ -2,11 +2,13 @@ displayed_sidebar: jsClientSidebar --- -# Class: AdminPostOrdersOrderReturnsReq +import ParameterTypes from "@site/src/components/ParameterTypes" -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderReturnsReq +# AdminPostOrdersOrderReturnsReq -**`Schema`** +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderReturnsReq + +#### Schema AdminPostOrdersOrderReturnsReq type: object @@ -60,70 +62,61 @@ properties: ## 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/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShipmentParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShipmentParams.mdx new file mode 100644 index 0000000000..5975a6bee3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShipmentParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderShipmentParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderShipmentParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShipmentReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShipmentReq.mdx new file mode 100644 index 0000000000..82672ad162 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShipmentReq.mdx @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderShipmentReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShippingMethodsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShippingMethodsParams.mdx new file mode 100644 index 0000000000..f0ffaf7363 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShippingMethodsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderShippingMethodsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderShippingMethodsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShippingMethodsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShippingMethodsReq.mdx new file mode 100644 index 0000000000..f9f1e73871 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderShippingMethodsReq.mdx @@ -0,0 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderShippingMethodsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.mdx new file mode 100644 index 0000000000..b0745be09a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderSwapFulfillementsCancelParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderSwapFulfillementsCancelParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsParams.mdx new file mode 100644 index 0000000000..49c814a589 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderSwapsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderSwapsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsReq.md b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsReq.mdx similarity index 56% rename from www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsReq.md rename to www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsReq.mdx index 5062b210cf..3370f63e6b 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsReq.md +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsReq.mdx @@ -2,11 +2,13 @@ displayed_sidebar: jsClientSidebar --- -# Class: AdminPostOrdersOrderSwapsReq +import ParameterTypes from "@site/src/components/ParameterTypes" -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderSwapsReq +# AdminPostOrdersOrderSwapsReq -**`Schema`** +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderSwapsReq + +#### Schema AdminPostOrdersOrderSwapsReq type: object @@ -86,80 +88,69 @@ properties: ## 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/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.mdx new file mode 100644 index 0000000000..09e70a05b0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderSwapsSwapFulfillmentsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderSwapsSwapFulfillmentsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.mdx new file mode 100644 index 0000000000..f5ec89e551 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderSwapsSwapFulfillmentsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderSwapsSwapFulfillmentsReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it.`true`, no notification will be sent to the customer related to this swap. + type: boolean + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.mdx new file mode 100644 index 0000000000..42f69b90cb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderSwapsSwapProcessPaymentParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderSwapsSwapProcessPaymentParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.mdx new file mode 100644 index 0000000000..24b3fb7cdc --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderSwapsSwapShipmentsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersOrderSwapsSwapShipmentsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.mdx new file mode 100644 index 0000000000..6bb0d9dfce --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.mdx @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersOrderSwapsSwapShipmentsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersSwapCancelParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersSwapCancelParams.mdx new file mode 100644 index 0000000000..ad36bef1eb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostOrdersSwapCancelParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostOrdersSwapCancelParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostOrdersSwapCancelParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPaymentRefundsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPaymentRefundsReq.mdx new file mode 100644 index 0000000000..bb861befc1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPaymentRefundsReq.mdx @@ -0,0 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostPaymentRefundsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListPricesPricesReq.md b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPriceListPricesPricesReq.mdx similarity index 68% rename from www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListPricesPricesReq.md rename to www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPriceListPricesPricesReq.mdx index 5ed0ded013..3e9cca8994 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListPricesPricesReq.md +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPriceListPricesPricesReq.mdx @@ -2,11 +2,13 @@ displayed_sidebar: jsClientSidebar --- -# Class: AdminPostPriceListPricesPricesReq +import ParameterTypes from "@site/src/components/ParameterTypes" -[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostPriceListPricesPricesReq +# AdminPostPriceListPricesPricesReq -**`Schema`** +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostPriceListPricesPricesReq + +#### Schema AdminPostPriceListPricesPricesReq type: object @@ -50,20 +52,21 @@ properties: ## 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/internal/classes/admin_discounts.internal.internal.AdminPostPriceListsPriceListPriceListReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPriceListsPriceListPriceListReq.mdx new file mode 100644 index 0000000000..9a320a25ce --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPriceListsPriceListPriceListReq.mdx @@ -0,0 +1,111 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostPriceListsPriceListPriceListReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostPriceListsPriceListPriceListReq + +#### Schema + +The name of the Price List`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`Tax included in prices of price list + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPriceListsPriceListReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPriceListsPriceListReq.mdx new file mode 100644 index 0000000000..df3fdb229d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPriceListsPriceListReq.mdx @@ -0,0 +1,108 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostPriceListsPriceListReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostPriceListsPriceListReq + +#### Schema + +The name of the Price List.`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`Tax included in prices of price list + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryParams.mdx new file mode 100644 index 0000000000..b1e23d4047 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductCategoriesCategoryParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostProductCategoriesCategoryParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryProductsBatchParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryProductsBatchParams.mdx new file mode 100644 index 0000000000..d2eb3aa676 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryProductsBatchParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductCategoriesCategoryProductsBatchParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostProductCategoriesCategoryProductsBatchParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryProductsBatchReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryProductsBatchReq.mdx new file mode 100644 index 0000000000..c1d951f250 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryProductsBatchReq.mdx @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductCategoriesCategoryProductsBatchReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryReq.mdx new file mode 100644 index 0000000000..986c45c449 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryReq.mdx @@ -0,0 +1,97 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductCategoriesCategoryReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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) + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesParams.mdx new file mode 100644 index 0000000000..45269d5b77 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductCategoriesParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostProductCategoriesParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesReq.mdx new file mode 100644 index 0000000000..0df989a918 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductCategoriesReq.mdx @@ -0,0 +1,88 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductCategoriesReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductMetadataReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductMetadataReq.mdx new file mode 100644 index 0000000000..cabadb6390 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductMetadataReq.mdx @@ -0,0 +1,45 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductsProductMetadataReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostProductsProductMetadataReq + +#### Schema + +AdminPostProductsProductMetadataReq +type: object +required: + - key + - value +properties: + key: + description: The metadata key + type: string + value: + description: The metadata value + type: string + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductOptionsOption.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductOptionsOption.mdx new file mode 100644 index 0000000000..90aacc035f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductOptionsOption.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductsProductOptionsOption + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostProductsProductOptionsOption + +#### Schema + +The title of the Product Option + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductOptionsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductOptionsReq.mdx new file mode 100644 index 0000000000..60a9959ba8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductOptionsReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductsProductOptionsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostProductsProductOptionsReq + +#### Schema + +The title the Product Option. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductReq.mdx new file mode 100644 index 0000000000..7e6b4855d2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductReq.mdx @@ -0,0 +1,235 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductsProductReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostProductsProductReq + +#### Schema + +The title of the Product`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`Sales channels to associate the Product with.`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`Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "``null`` \\| [`ProductSalesChannelReq`](admin_discounts.internal.ProductSalesChannelReq.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/admin_collections.internal.ProductStatus.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTagReq`](admin_discounts.internal.ProductTagReq.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductTypeReq`](admin_discounts.internal.ProductTypeReq.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariantReq`](admin_discounts.internal.ProductVariantReq-1.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductVariantsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductVariantsReq.mdx new file mode 100644 index 0000000000..5fa04d545c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductVariantsReq.mdx @@ -0,0 +1,201 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductsProductVariantsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostProductsProductVariantsReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it.`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 + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductVariantOptionReq`](admin_discounts.internal.ProductVariantOptionReq.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`ProductVariantPricesCreateReq`](admin_discounts.internal.ProductVariantPricesCreateReq.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductVariantsVariantReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductVariantsVariantReq.mdx new file mode 100644 index 0000000000..da9ab0446a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsProductVariantsVariantReq.mdx @@ -0,0 +1,201 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductsProductVariantsVariantReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostProductsProductVariantsVariantReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it.`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 + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductVariantOptionReq`](admin_discounts.internal.ProductVariantOptionReq-1.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`ProductVariantPricesUpdateReq`](admin_discounts.internal.ProductVariantPricesUpdateReq.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsReq.mdx new file mode 100644 index 0000000000..f1ea317974 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostProductsReq.mdx @@ -0,0 +1,297 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostProductsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostProductsReq + +#### Schema + +The title of the Product`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 API Routes 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 API Routes 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`Sales channels to associate the Product with.`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`Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionReq`](admin_discounts.internal.ProductOptionReq.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`ProductSalesChannelReq`](admin_discounts.internal.ProductSalesChannelReq.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/admin_collections.internal.ProductStatus.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTagReq`](admin_discounts.internal.ProductTagReq.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductTypeReq`](admin_discounts.internal.ProductTypeReq.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariantReq`](admin_discounts.internal.ProductVariantReq.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.mdx new file mode 100644 index 0000000000..198546d028 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.mdx @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostPublishableApiKeySalesChannelsBatchReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.mdx new file mode 100644 index 0000000000..acecce642a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.mdx @@ -0,0 +1,31 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostPublishableApiKeysPublishableApiKeyReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostPublishableApiKeysPublishableApiKeyReq + +#### Schema + +AdminPostPublishableApiKeysPublishableApiKeyReq +type: object +properties: + title: + description: The title of the Publishable API Key. + type: string + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPublishableApiKeysReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPublishableApiKeysReq.mdx new file mode 100644 index 0000000000..1f40897acf --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostPublishableApiKeysReq.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostPublishableApiKeysReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostPublishableApiKeysReq + +#### Schema + +AdminPostPublishableApiKeysReq +type: object +required: + - title +properties: + title: + description: The title of the publishable API key + type: string + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionCountriesReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionCountriesReq.mdx new file mode 100644 index 0000000000..438720615e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionCountriesReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostRegionsRegionCountriesReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostRegionsRegionCountriesReq + +#### Schema + +The 2 character ISO code for the Country. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionFulfillmentProvidersReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionFulfillmentProvidersReq.mdx new file mode 100644 index 0000000000..beab87a083 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionFulfillmentProvidersReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostRegionsRegionFulfillmentProvidersReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostRegionsRegionFulfillmentProvidersReq + +#### Schema + +The ID of the Fulfillment Provider. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionPaymentProvidersReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionPaymentProvidersReq.mdx new file mode 100644 index 0000000000..0324fb3def --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionPaymentProvidersReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostRegionsRegionPaymentProvidersReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostRegionsRegionPaymentProvidersReq + +#### Schema + +The ID of the Payment Provider. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionReq.mdx new file mode 100644 index 0000000000..0dadf65b32 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsRegionReq.mdx @@ -0,0 +1,120 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostRegionsRegionReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostRegionsRegionReq + +#### Schema + +The name of the Region`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`The ID of the tax provider to use. If none provided, the system tax provider is used. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "`string`[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsReq.mdx new file mode 100644 index 0000000000..03d5751e39 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostRegionsReq.mdx @@ -0,0 +1,90 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostRegionsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostRegionsReq + +#### Schema + +The name of the Region + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReservationsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReservationsReq.mdx new file mode 100644 index 0000000000..f0dee77a45 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReservationsReq.mdx @@ -0,0 +1,66 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostReservationsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostReservationsReq + +#### Schema + +The ID of the line item of the reservation. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReservationsReservationReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReservationsReservationReq.mdx new file mode 100644 index 0000000000..d7e910e3da --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReservationsReservationReq.mdx @@ -0,0 +1,50 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostReservationsReservationReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostReservationsReservationReq + +#### Schema + +The ID of the location associated with the reservation. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReturnReasonsReasonReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReturnReasonsReasonReq.mdx new file mode 100644 index 0000000000..e736e9a56c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReturnReasonsReasonReq.mdx @@ -0,0 +1,50 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostReturnReasonsReasonReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostReturnReasonsReasonReq + +#### Schema + +The label to display to the Customer. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReturnReasonsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReturnReasonsReq.mdx new file mode 100644 index 0000000000..c9c80732a3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReturnReasonsReq.mdx @@ -0,0 +1,58 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostReturnReasonsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostReturnReasonsReq + +#### Schema + +The label to display to the Customer. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReturnsReturnReceiveReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReturnsReturnReceiveReq.mdx new file mode 100644 index 0000000000..d4377ddafe --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostReturnsReturnReceiveReq.mdx @@ -0,0 +1,64 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostReturnsReturnReceiveReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsChannelProductsBatchReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsChannelProductsBatchReq.mdx new file mode 100644 index 0000000000..621040e55a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsChannelProductsBatchReq.mdx @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostSalesChannelsChannelProductsBatchReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsChannelStockLocationsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsChannelStockLocationsReq.mdx new file mode 100644 index 0000000000..959c346d59 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsChannelStockLocationsReq.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostSalesChannelsChannelStockLocationsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostSalesChannelsChannelStockLocationsReq + +#### Schema + +AdminPostSalesChannelsChannelStockLocationsReq +type: object +required: + - location_id +properties: + location_id: + description: The ID of the stock location + type: string + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsReq.mdx new file mode 100644 index 0000000000..120dab4206 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsReq.mdx @@ -0,0 +1,55 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostSalesChannelsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsSalesChannelReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsSalesChannelReq.mdx new file mode 100644 index 0000000000..49e5a0352f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostSalesChannelsSalesChannelReq.mdx @@ -0,0 +1,53 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostSalesChannelsSalesChannelReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingOptionsOptionReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingOptionsOptionReq.mdx new file mode 100644 index 0000000000..f5177648d6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingOptionsOptionReq.mdx @@ -0,0 +1,69 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostShippingOptionsOptionReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostShippingOptionsOptionReq + +#### Schema + +The name of the Shipping Option`price_type` of the shipping option is `calculated`, this amount will not actually be used." + type: integer + admin_only: + description: If set to `true`An optional set of key-value pairs with additional information. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`OptionRequirement`](admin_discounts.internal.OptionRequirement-1.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingOptionsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingOptionsReq.mdx new file mode 100644 index 0000000000..b27ef08177 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingOptionsReq.mdx @@ -0,0 +1,120 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostShippingOptionsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostShippingOptionsReq + +#### Schema + +The name of the Shipping Option`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`The requirements that must be satisfied for the Shipping Option to be available.`true`Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`OptionRequirement`](admin_discounts.internal.OptionRequirement.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingProfilesProfileReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingProfilesProfileReq.mdx new file mode 100644 index 0000000000..fd61c6e813 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingProfilesProfileReq.mdx @@ -0,0 +1,58 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostShippingProfilesProfileReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostShippingProfilesProfileReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "`string`[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "`string`[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/admin_collections.internal.ShippingProfileType.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingProfilesReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingProfilesReq.mdx new file mode 100644 index 0000000000..31e1bee5d3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostShippingProfilesReq.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostShippingProfilesReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/admin_collections.internal.ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsLocationParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsLocationParams.mdx new file mode 100644 index 0000000000..76dd892b6f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsLocationParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostStockLocationsLocationParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostStockLocationsLocationParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsLocationReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsLocationReq.mdx new file mode 100644 index 0000000000..f514e6520b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsLocationReq.mdx @@ -0,0 +1,50 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostStockLocationsLocationReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostStockLocationsLocationReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsParams.mdx new file mode 100644 index 0000000000..a6e203eec0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostStockLocationsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostStockLocationsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsReq.mdx new file mode 100644 index 0000000000..d6948bfaf6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStockLocationsReq.mdx @@ -0,0 +1,60 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostStockLocationsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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`Learn about the metadata attribute, and how to delete and update it.`address_id` is not provided. + $ref: "#/components/schemas/StockLocationAddressInput" + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStoreReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStoreReq.mdx new file mode 100644 index 0000000000..1395197318 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostStoreReq.mdx @@ -0,0 +1,82 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostStoreReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostStoreReq + +#### Schema + +The name of the Store`{{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}}`The default currency code of the Store. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_link_template", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_link_template", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesParams.mdx new file mode 100644 index 0000000000..21a25d7657 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostTaxRatesParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostTaxRatesParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesReq.mdx new file mode 100644 index 0000000000..e4dcd37655 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesReq.mdx @@ -0,0 +1,74 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostTaxRatesReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostTaxRatesReq + +#### Schema + +The code of the tax rate. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateParams.mdx new file mode 100644 index 0000000000..bdddc45a94 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostTaxRatesTaxRateParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostTaxRatesTaxRateParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductTypesParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductTypesParams.mdx new file mode 100644 index 0000000000..f1667e406b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductTypesParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostTaxRatesTaxRateProductTypesParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostTaxRatesTaxRateProductTypesParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductTypesReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductTypesReq.mdx new file mode 100644 index 0000000000..ae6fc7469a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductTypesReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostTaxRatesTaxRateProductTypesReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostTaxRatesTaxRateProductTypesReq + +#### Schema + +The IDs of the types of products to associate with this tax rate + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductsParams.mdx new file mode 100644 index 0000000000..9e9b70ea97 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostTaxRatesTaxRateProductsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostTaxRatesTaxRateProductsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductsReq.mdx new file mode 100644 index 0000000000..71a11a5f0a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductsReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostTaxRatesTaxRateProductsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostTaxRatesTaxRateProductsReq + +#### Schema + +The IDs of the products to associate with this tax rate + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateReq.mdx new file mode 100644 index 0000000000..571f635f5b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateReq.mdx @@ -0,0 +1,74 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostTaxRatesTaxRateReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostTaxRatesTaxRateReq + +#### Schema + +The code of the tax rate. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateShippingOptionsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateShippingOptionsParams.mdx new file mode 100644 index 0000000000..15d58147d4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateShippingOptionsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostTaxRatesTaxRateShippingOptionsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostTaxRatesTaxRateShippingOptionsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.mdx new file mode 100644 index 0000000000..eeaf1665c8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostTaxRatesTaxRateShippingOptionsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostTaxRatesTaxRateShippingOptionsReq + +#### Schema + +The IDs of the shipping options to associate with this tax rate + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostUploadsDownloadUrlReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostUploadsDownloadUrlReq.mdx new file mode 100644 index 0000000000..5e4b02b2aa --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPostUploadsDownloadUrlReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPostUploadsDownloadUrlReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPostUploadsDownloadUrlReq + +#### Schema + +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. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPriceListPricesCreateReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPriceListPricesCreateReq.mdx new file mode 100644 index 0000000000..486218e753 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPriceListPricesCreateReq.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPriceListPricesCreateReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPriceListPricesCreateReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPriceListPricesUpdateReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPriceListPricesUpdateReq.mdx new file mode 100644 index 0000000000..7efdf42f10 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminPriceListPricesUpdateReq.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminPriceListPricesUpdateReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminPriceListPricesUpdateReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx new file mode 100644 index 0000000000..c6ef139981 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminRegionsRes + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminRegionsRes + +#### Schema + +Region details. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminResetPasswordRequest.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminResetPasswordRequest.mdx new file mode 100644 index 0000000000..34c98ba9bd --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminResetPasswordRequest.mdx @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminResetPasswordRequest + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminResetPasswordRequest + +#### Schema + +The User's email. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminResetPasswordTokenRequest.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminResetPasswordTokenRequest.mdx new file mode 100644 index 0000000000..d5094c737f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminResetPasswordTokenRequest.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminResetPasswordTokenRequest + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminResetPasswordTokenRequest + +#### Schema + +The User's email. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminUpdatePaymentCollectionsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminUpdatePaymentCollectionsReq.mdx new file mode 100644 index 0000000000..04d975fe3c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminUpdatePaymentCollectionsReq.mdx @@ -0,0 +1,34 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminUpdatePaymentCollectionsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminUpdatePaymentCollectionsReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx new file mode 100644 index 0000000000..2a4ad88494 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx @@ -0,0 +1,58 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AdminUpdateUserRequest + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AdminUpdateUserRequest + +#### Schema + +The first name of the User. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "role", + "type": "[`UserRoles`](../enums/admin_auth.internal.UserRoles.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AnalyticsConfig.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AnalyticsConfig.mdx new file mode 100644 index 0000000000..07ff4ee33b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AnalyticsConfig.mdx @@ -0,0 +1,80 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AnalyticsConfig + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AnalyticsConfig + +Base abstract entity for all entities + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AnalyticsConfigService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AnalyticsConfigService.mdx new file mode 100644 index 0000000000..d38e400613 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AnalyticsConfigService.mdx @@ -0,0 +1,433 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AnalyticsConfigService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AnalyticsConfigService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "analyticsConfigRepository_", + "type": "`Repository`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "userService_", + "type": "[`UserService`](admin_discounts.internal.internal.UserService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`userId`, `data`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\> + +Creates an analytics config. + +#### Parameters + + + +#### Returns + +`Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AnalyticsConfig", + "type": "[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`userId`): `Promise`<`void`\> + +Deletes an analytics config. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`userId`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AnalyticsConfig", + "type": "[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`userId`, `update`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\> + +Updates an analytics config. If the config does not exist, it will be created instead. + +#### Parameters + + + +#### Returns + +`Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AnalyticsConfig", + "type": "[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AnalyticsConfigService`](admin_discounts.internal.internal.AnalyticsConfigService.mdx) + +#### Parameters + + + +#### Returns + +[`AnalyticsConfigService`](admin_discounts.internal.internal.AnalyticsConfigService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AuthService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AuthService.mdx new file mode 100644 index 0000000000..9337fe22e4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AuthService.mdx @@ -0,0 +1,456 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AuthService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).AuthService + +Can authenticate a user based on email password combination + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "customerService_", + "type": "[`CustomerService`](admin_discounts.internal.internal.CustomerService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "userService_", + "type": "[`UserService`](admin_discounts.internal.internal.UserService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### authenticate + +▸ **authenticate**(`email`, `password`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\> + +Authenticates a given user based on an email, password combination. Uses +scrypt to match password with hashed value. + +#### Parameters + + + +#### Returns + +`Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\> + +", + "optional": false, + "defaultValue": "", + "description": "success: whether authentication succeeded\n user: the user document if authentication succeeded\n error: a string with the error message", + "children": [ + { + "name": "AuthenticateResult", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### authenticateAPIToken + +▸ **authenticateAPIToken**(`token`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\> + +Authenticates a given user with an API token + +#### Parameters + + + +#### Returns + +`Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\> + +", + "optional": false, + "defaultValue": "", + "description": "success: whether authentication succeeded\n user: the user document if authentication succeeded\n error: a string with the error message", + "children": [ + { + "name": "AuthenticateResult", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### authenticateCustomer + +▸ **authenticateCustomer**(`email`, `password`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\> + +Authenticates a customer based on an email, password combination. Uses +scrypt to match password with hashed value. + +#### Parameters + + + +#### Returns + +`Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\> + +", + "optional": false, + "defaultValue": "", + "description": "success: whether authentication succeeded\n customer: the customer document if authentication succeded\n error: a string with the error message", + "children": [ + { + "name": "AuthenticateResult", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### comparePassword\_ + +▸ `Protected` **comparePassword_**(`password`, `hash`): `Promise`<`boolean`\> + +Verifies if a password is valid given the provided password hash + +#### Parameters + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the comparison", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AuthService`](admin_discounts.internal.internal.AuthService.mdx) + +#### Parameters + + + +#### Returns + +[`AuthService`](admin_discounts.internal.internal.AuthService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.BatchJobService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.BatchJobService.mdx new file mode 100644 index 0000000000..bc481b6e67 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.BatchJobService.mdx @@ -0,0 +1,908 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# BatchJobService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).BatchJobService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "batchJobRepository_", + "type": "`Repository`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "batchJobStatusMapToProps", + "type": "`Map`<[`BatchJobStatus`](../enums/admin_batch_jobs.internal.BatchJobStatus.mdx), { `entityColumnName`: `string` ; `eventType`: `string` }\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "strategyResolver_", + "type": "[`StrategyResolverService`](admin_discounts.internal.internal.StrategyResolverService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CANCELED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.COMPLETED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CONFIRMED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.FAILED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PRE_PROCESSED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PROCESSING", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### cancel + +▸ **cancel**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "BatchJob", + "type": "[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### complete + +▸ **complete**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "BatchJob", + "type": "[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### confirm + +▸ **confirm**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "BatchJob", + "type": "[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`data`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "BatchJob", + "type": "[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)[], `number`]\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "BatchJob[]", + "type": "[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### prepareBatchJobForProcessing + +▸ **prepareBatchJobForProcessing**(`data`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\> + +#### Parameters + +\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "CreateBatchJobInput", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`batchJobId`, `config?`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "BatchJob", + "type": "[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### setFailed + +▸ **setFailed**(`batchJobOrId`, `error?`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "BatchJob", + "type": "[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### setPreProcessingDone + +▸ **setPreProcessingDone**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "BatchJob", + "type": "[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### setProcessing + +▸ **setProcessing**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "BatchJob", + "type": "[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`batchJobOrId`, `data`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +#### Parameters + +\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "BatchJob", + "type": "[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateStatus + +▸ `Protected` **updateStatus**(`batchJobOrId`, `status`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "BatchJob", + "type": "[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`BatchJobService`](admin_discounts.internal.internal.BatchJobService.mdx) + +#### Parameters + + + +#### Returns + +[`BatchJobService`](admin_discounts.internal.internal.BatchJobService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CartService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CartService.mdx new file mode 100644 index 0000000000..0c252dd98c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CartService.mdx @@ -0,0 +1,2573 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CartService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).CartService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "addressRepository_", + "type": "`Repository`<[`Address`](admin_collections.internal.Address.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cartRepository_", + "type": "`Repository`<[`Cart`](admin_collections.internal.Cart.mdx)\\> & { `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customShippingOptionService_", + "type": "[`CustomShippingOptionService`](admin_discounts.internal.internal.CustomShippingOptionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customerService_", + "type": "[`CustomerService`](admin_discounts.internal.internal.CustomerService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountService_", + "type": "[`DiscountService`](admin_discounts.internal.internal.DiscountService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "getTotalsRelations", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "giftCardService_", + "type": "[`GiftCardService`](admin_discounts.internal.internal.GiftCardService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemAdjustmentService_", + "type": "[`LineItemAdjustmentService`](admin_discounts.internal.internal.LineItemAdjustmentService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemRepository_", + "type": "`Repository`<[`LineItem`](admin_collections.internal.LineItem.mdx)\\> & { `findByReturn`: Method findByReturn }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemService_", + "type": "[`LineItemService`](admin_discounts.internal.internal.LineItemService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "newTotalsService_", + "type": "[`NewTotalsService`](admin_discounts.internal.internal.NewTotalsService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentProviderService_", + "type": "[`PaymentProviderService`](admin_discounts.internal.internal.PaymentProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentSessionRepository_", + "type": "`Repository`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "priceSelectionStrategy_", + "type": "[`IPriceSelectionStrategy`](../interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "pricingService_", + "type": "[`PricingService`](admin_discounts.internal.internal.PricingService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productService_", + "type": "[`ProductService`](admin_discounts.internal.internal.ProductService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantInventoryService_", + "type": "[`ProductVariantInventoryService`](admin_discounts.internal.internal.ProductVariantInventoryService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantService_", + "type": "[`ProductVariantService`](admin_discounts.internal.internal.ProductVariantService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regionService_", + "type": "[`RegionService`](admin_discounts.internal.internal.RegionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "salesChannelService_", + "type": "[`SalesChannelService`](admin_discounts.internal.internal.SalesChannelService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingMethodRepository_", + "type": "`Repository`<[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingOptionService_", + "type": "[`ShippingOptionService`](admin_discounts.internal.internal.ShippingOptionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingProfileService_", + "type": "[`ShippingProfileService`](admin_discounts.internal.internal.ShippingProfileService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "storeService_", + "type": "[`StoreService`](admin_discounts.internal.internal.StoreService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxProviderService_", + "type": "[`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "totalsService_", + "type": "[`TotalsService`](admin_discounts.internal.internal.TotalsService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CUSTOMER_UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addLineItem + +▸ **addLineItem**(`cartId`, `lineItem`, `config?`): `Promise`<`void`\> + +Adds a line item to the cart. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [] + } +]} /> + +#### Deprecated + +Use [addOrUpdateLineItems](admin_discounts.internal.internal.CartService.mdx#addorupdatelineitems) instead. + +___ + +### 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 + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [] + } +]} /> + +___ + +### addShippingMethod + +▸ **addShippingMethod**(`cartOrId`, `optionId`, `data?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +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 + +", + "description": "the fulmillment data for the method", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "void", + "children": [] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### applyGiftCard\_ + +▸ `Protected` **applyGiftCard_**(`cart`, `code`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### authorizePayment + +▸ **authorizePayment**(`cartId`, `context?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +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 + + & { `cart_id`: `string` }", + "description": "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.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the resulting cart", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`data`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +Creates a cart. + +#### Parameters + + + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the create operation", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createOrFetchGuestCustomerFromEmail\_ + +▸ `Protected` **createOrFetchGuestCustomerFromEmail_**(`email`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +Creates or fetches a user based on an email. + +#### Parameters + + + +#### Returns + +`Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the resultign customer object", + "children": [ + { + "name": "Customer", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createTaxLines + +▸ **createTaxLines**(`cartOrId`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### decorateTotals + +▸ **decorateTotals**(`cart`, `totalsConfig?`): `Promise`<[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``"total"``\>\> + +#### Parameters + + + +#### Returns + +`Promise`<[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``"total"``\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "WithRequiredProperty", + "type": "[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``\"total\"``\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "``\"total\"``", + "type": "``\"total\"``", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### decorateTotals\_ + +▸ `Protected` **decorateTotals_**(`cart`, `totalsToSelect`, `options?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +Use decorateTotals instead + +___ + +### delete + +▸ **delete**(`cartId`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +Deletes a cart from the database. Completed carts cannot be deleted. + +#### Parameters + + + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the deleted cart or undefined if the cart was not found.", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### deletePaymentSession + +▸ **deletePaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> + +Removes a payment session from the cart. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the resulting cart.", + "children": [] + } +]} /> + +___ + +### deleteTaxLines + +▸ **deleteTaxLines**(`id`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### findCustomShippingOption + +▸ **findCustomShippingOption**(`cartCustomShippingOptions`, `optionId`): `undefined` \| [`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx) + +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 + + + +#### Returns + +`undefined` \| [`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx) + + + +___ + +### getValidatedSalesChannel + +▸ `Protected` **getValidatedSalesChannel**(`salesChannelId?`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "SalesChannel", + "type": "[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)[]\> + +#### Parameters + +", + "description": "config object", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "Cart[]", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### onSalesChannelChange + +▸ `Protected` **onSalesChannelChange**(`cart`, `newSalesChannelId`): `Promise`<`void`\> + +Remove the cart line item that does not belongs to the newly assigned sales channel + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "void", + "children": [] + } +]} /> + +___ + +### refreshAdjustments\_ + +▸ `Protected` **refreshAdjustments_**(`cart`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### refreshPaymentSession + +▸ **refreshPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> + +Refreshes a payment session on a cart + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the resulting cart.", + "children": [] + } +]} /> + +___ + +### removeDiscount + +▸ **removeDiscount**(`cartId`, `discountCode`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +Removes a discount based on a discount code. + +#### Parameters + + + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the resulting cart", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeLineItem + +▸ **removeLineItem**(`cartId`, `lineItemId`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +Removes a line item from the cart. + +#### Parameters + + + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +Gets a cart by id. + +#### Parameters + +", + "description": "the options to get a cart", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "totalsConfig", + "type": "[`TotalsConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#totalsconfig)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the cart document.", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveLegacy + +▸ `Protected` **retrieveLegacy**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "totalsConfig", + "type": "[`TotalsConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#totalsconfig)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +___ + +### retrieveWithTotals + +▸ **retrieveWithTotals**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``"total"``\>\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "totalsConfig", + "type": "[`TotalsConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#totalsconfig)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``"total"``\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "WithRequiredProperty", + "type": "[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``\"total\"``\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "``\"total\"``", + "type": "``\"total\"``", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### setMetadata + +▸ **setMetadata**(`cartId`, `key`, `value`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +Dedicated method to set metadata for a cart. +To ensure that plugins does not overwrite each +others metadata fields, setMetadata is provided. + +#### Parameters + + + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the updated result.", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### setPaymentSession + +▸ **setPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> + +Selects a payment session for a cart and creates a payment object in the external provider system + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation.", + "children": [] + } +]} /> + +___ + +### setRegion\_ + +▸ `Protected` **setRegion_**(`cart`, `regionId`, `countryCode`): `Promise`<`void`\> + +Set's the region of a cart. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### transformQueryForTotals\_ + +▸ `Protected` **transformQueryForTotals_**(`config`): [`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Cart`](admin_collections.internal.Cart.mdx)\> & { `totalsToSelect`: [`TotalField`](../modules/admin_discounts.internal.internal.mdx#totalfield)[] } + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Cart`](admin_collections.internal.Cart.mdx)\> & { `totalsToSelect`: [`TotalField`](../modules/admin_discounts.internal.internal.mdx#totalfield)[] } + + & { `totalsToSelect`: [`TotalField`](../modules/admin_discounts.internal.internal.mdx#totalfield)[] }", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Cart`](admin_collections.internal.Cart.mdx)\\> & { `totalsToSelect`: [`TotalField`](../modules/admin_discounts.internal.internal.mdx#totalfield)[] }", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### update + +▸ **update**(`cartOrId`, `data`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateBillingAddress\_ + +▸ `Protected` **updateBillingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\> + +Updates the cart's billing address. + +#### Parameters + +", + "description": "the value to set the billing address to", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "addrRepo", + "type": "`Repository`<[`Address`](admin_collections.internal.Address.mdx)\\>", + "description": "the repository to use for address updates", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [] + } +]} /> + +___ + +### updateCustomerId\_ + +▸ `Protected` **updateCustomerId_**(`cart`, `customerId`): `Promise`<`void`\> + +Sets the customer id of a cart + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [] + } +]} /> + +___ + +### updateLineItem + +▸ **updateLineItem**(`cartId`, `lineItemId`, `update`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +Updates a cart's existing line item. + +#### Parameters + + + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updatePaymentSession + +▸ **updatePaymentSession**(`cartId`, `update`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +Updates the currently selected payment session. + +#### Parameters + +", + "description": "the data to update the payment session with", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the resulting cart", + "children": [ + { + "name": "Cart", + "type": "[`Cart`](admin_collections.internal.Cart.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateShippingAddress\_ + +▸ `Protected` **updateShippingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\> + +Updates the cart's shipping address. + +#### Parameters + +", + "description": "the value to set the shipping address to", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "addrRepo", + "type": "`Repository`<[`Address`](admin_collections.internal.Address.mdx)\\>", + "description": "the repository to use for address updates", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [] + } +]} /> + +___ + +### updateUnitPrices\_ + +▸ `Protected` **updateUnitPrices_**(`cart`, `regionId?`, `customer_id?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### validateLineItem + +▸ `Protected` **validateLineItem**(`sales_channel_id`, `lineItem`): `Promise`<`boolean`\> + +Check if line item's variant belongs to the cart's sales channel. + +#### Parameters + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "a boolean indicating validation result", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`CartService`](admin_discounts.internal.internal.CartService.mdx) + +#### Parameters + + + +#### Returns + +[`CartService`](admin_discounts.internal.internal.CartService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimItemService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimItemService.mdx new file mode 100644 index 0000000000..2d50819622 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimItemService.mdx @@ -0,0 +1,511 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimItemService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ClaimItemService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "claimImageRepository_", + "type": "`Repository`<[`ClaimImage`](admin_collections.internal.ClaimImage.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claimItemRepository_", + "type": "`Repository`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claimTagRepository_", + "type": "`Repository`<[`ClaimTag`](admin_collections.internal.ClaimTag.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemService_", + "type": "[`LineItemService`](admin_discounts.internal.internal.LineItemService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CANCELED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`data`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ClaimItem", + "type": "[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)[]\> + +#### Parameters + +", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\\>", + "description": "the config object for find", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "ClaimItem[]", + "type": "[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ClaimItem", + "type": "[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`claimItemId`, `config?`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\> + +Gets a claim item by id. + +#### Parameters + +", + "description": "configuration for the find operation", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the ClaimItem", + "children": [ + { + "name": "ClaimItem", + "type": "[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`id`, `data`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ClaimItem", + "type": "[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ClaimItemService`](admin_discounts.internal.internal.ClaimItemService.mdx) + +#### Parameters + + + +#### Returns + +[`ClaimItemService`](admin_discounts.internal.internal.ClaimItemService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimService.mdx new file mode 100644 index 0000000000..d3c35038d8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimService.mdx @@ -0,0 +1,1006 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ClaimService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "addressRepository_", + "type": "`Repository`<[`Address`](admin_collections.internal.Address.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claimItemService_", + "type": "[`ClaimItemService`](admin_discounts.internal.internal.ClaimItemService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claimRepository_", + "type": "`Repository`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillmentProviderService_", + "type": "[`FulfillmentProviderService`](admin_discounts.internal.internal.FulfillmentProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillmentService_", + "type": "[`FulfillmentService`](admin_discounts.internal.FulfillmentService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemRepository_", + "type": "`Repository`<[`LineItem`](admin_collections.internal.LineItem.mdx)\\> & { `findByReturn`: Method findByReturn }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemService_", + "type": "[`LineItemService`](admin_discounts.internal.internal.LineItemService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentProviderService_", + "type": "[`PaymentProviderService`](admin_discounts.internal.internal.PaymentProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantInventoryService_", + "type": "[`ProductVariantInventoryService`](admin_discounts.internal.internal.ProductVariantInventoryService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regionService_", + "type": "[`RegionService`](admin_discounts.internal.internal.RegionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnService_", + "type": "[`ReturnService`](admin_discounts.internal.internal.ReturnService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingMethodRepository_", + "type": "`Repository`<[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingOptionService_", + "type": "[`ShippingOptionService`](admin_discounts.internal.internal.ShippingOptionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxProviderService_", + "type": "[`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "totalsService_", + "type": "[`TotalsService`](admin_discounts.internal.internal.TotalsService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CANCELED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.FULFILLMENT_CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.REFUND_PROCESSED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.SHIPMENT_CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### cancel + +▸ **cancel**(`id`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ClaimOrder", + "type": "[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ClaimOrder", + "type": "[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`data`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "created claim", + "children": [ + { + "name": "ClaimOrder", + "type": "[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createFulfillment + +▸ **createFulfillment**(`id`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +#### Parameters + +", + "description": "config metadata", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config.no_notification", + "type": "`boolean`", + "description": "config no notification", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "created claim", + "children": [ + { + "name": "ClaimOrder", + "type": "[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createShipment + +▸ **createShipment**(`id`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ClaimOrder", + "type": "[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "the refund amount", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)[]\> + +#### Parameters + +", + "description": "the config object containing query settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "ClaimOrder[]", + "type": "[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ClaimOrder", + "type": "[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### processRefund + +▸ **processRefund**(`id`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ClaimOrder", + "type": "[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`claimId`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +Gets an order by id. + +#### Parameters + +", + "description": "the config object containing query settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the order document", + "children": [ + { + "name": "ClaimOrder", + "type": "[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`id`, `data`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ClaimOrder", + "type": "[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### validateCreateClaimInput + +▸ `Protected` **validateCreateClaimInput**(`data`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ClaimService`](admin_discounts.internal.internal.ClaimService.mdx) + +#### Parameters + + + +#### Returns + +[`ClaimService`](admin_discounts.internal.internal.ClaimService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CurrencyService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CurrencyService.mdx new file mode 100644 index 0000000000..fb83bd7583 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CurrencyService.mdx @@ -0,0 +1,432 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CurrencyService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).CurrencyService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currencyRepository_", + "type": "`Repository`<[`Currency`](admin_collections.internal.Currency.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBusService_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Currency`](admin_collections.internal.Currency.mdx)[], `number`]\> + +Lists currencies based on the provided parameters and includes the count of +currencies that match the query. + +#### Parameters + +", + "description": "an object that defines rules to filter currencies by", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Currency`](admin_collections.internal.Currency.mdx)\\>", + "description": "object that defines the scope for what should be returned", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`Currency`](admin_collections.internal.Currency.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "an array containing the currencies as\n the first element and the total count of products that matches the query\n as the second element.", + "children": [ + { + "name": "Currency[]", + "type": "[`Currency`](admin_collections.internal.Currency.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByCode + +▸ **retrieveByCode**(`code`): `Promise`<[`Currency`](admin_collections.internal.Currency.mdx)\> + +Return the currency + +#### Parameters + + + +#### Returns + +`Promise`<[`Currency`](admin_collections.internal.Currency.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "The currency", + "children": [ + { + "name": "Currency", + "type": "[`Currency`](admin_collections.internal.Currency.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`code`, `data`): `Promise`<`undefined` \| [`Currency`](admin_collections.internal.Currency.mdx)\> + +Update a currency + +#### Parameters + + + +#### Returns + +`Promise`<`undefined` \| [`Currency`](admin_collections.internal.Currency.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "The updated currency", + "children": [ + { + "name": "undefined \\| Currency", + "type": "`undefined` \\| [`Currency`](admin_collections.internal.Currency.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`CurrencyService`](admin_discounts.internal.internal.CurrencyService.mdx) + +#### Parameters + + + +#### Returns + +[`CurrencyService`](admin_discounts.internal.internal.CurrencyService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomShippingOption.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomShippingOption.mdx new file mode 100644 index 0000000000..178839928c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomShippingOption.mdx @@ -0,0 +1,104 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomShippingOption + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).CustomShippingOption + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomShippingOptionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomShippingOptionService.mdx new file mode 100644 index 0000000000..b427f6017b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomShippingOptionService.mdx @@ -0,0 +1,410 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomShippingOptionService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).CustomShippingOptionService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "customShippingOptionRepository_", + "type": "`Repository`<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\> + +Creates a custom shipping option + + + +#### Parameters + + + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the creation result", + "children": [] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)[]\> + +Fetches all custom shipping options based on the given selector + +#### Parameters + +", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)\\>", + "description": "the configuration used to find the objects. contains relations, skip, and take.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "custom shipping options matching the query", + "children": [ + { + "name": "CustomShippingOption[]", + "type": "[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "CustomShippingOption", + "type": "[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`): `Promise`<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)\> + +Retrieves a specific shipping option. + +#### Parameters + +", + "description": "any options needed to query for the result.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the requested custom shipping option.", + "children": [ + { + "name": "CustomShippingOption", + "type": "[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`CustomShippingOptionService`](admin_discounts.internal.internal.CustomShippingOptionService.mdx) + +#### Parameters + + + +#### Returns + +[`CustomShippingOptionService`](admin_discounts.internal.internal.CustomShippingOptionService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerGroupService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerGroupService.mdx new file mode 100644 index 0000000000..2668186158 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerGroupService.mdx @@ -0,0 +1,670 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomerGroupService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).CustomerGroupService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "customerGroupRepository_", + "type": "`Repository`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\\> & { `addCustomers`: Method addCustomers ; `findWithRelationsAndCount`: Method findWithRelationsAndCount ; `removeCustomers`: Method removeCustomers }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customerService_", + "type": "[`CustomerService`](admin_discounts.internal.internal.CustomerService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handleCreationFail", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addCustomers + +▸ **addCustomers**(`id`, `customerIds`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> + +Add a batch of customers to a customer group at once + +#### Parameters + + + +#### Returns + +`Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the customer group after insertion", + "children": [ + { + "name": "CustomerGroup", + "type": "[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`group`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> + +Creates a customer group with the provided data. + +#### Parameters + +", + "description": "the customer group to create", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the create operation", + "children": [ + { + "name": "CustomerGroup", + "type": "[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`groupId`): `Promise`<`void`\> + +Remove customer group + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "a promise", + "children": [] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)[]\> + +List customer groups. + +#### Parameters + + & { `discount_condition_id?`: `string` ; `q?`: `string` }", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\\>", + "description": "the config to be used for find", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "CustomerGroup[]", + "type": "[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "CustomerGroup", + "type": "[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config`): `Promise`<[[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)[], `number`]\> + +Retrieve a list of customer groups and total count of records that match the query. + +#### Parameters + + & { `discount_condition_id?`: `string` ; `q?`: `string` }", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\\>", + "description": "the config to be used for find", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "CustomerGroup[]", + "type": "[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeCustomer + +▸ **removeCustomer**(`id`, `customerIds`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> + +Remove list of customers from a customergroup + +#### Parameters + + + +#### Returns + +`Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the customergroup with the provided id", + "children": [ + { + "name": "CustomerGroup", + "type": "[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`customerGroupId`, `config?`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "CustomerGroup", + "type": "[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`customerGroupId`, `update`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> + +Update a customer group. + +#### Parameters + + + +#### Returns + +`Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resulting customer group", + "children": [ + { + "name": "CustomerGroup", + "type": "[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`CustomerGroupService`](admin_discounts.internal.internal.CustomerGroupService.mdx) + +#### Parameters + + + +#### Returns + +[`CustomerGroupService`](admin_discounts.internal.internal.CustomerGroupService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerService.mdx new file mode 100644 index 0000000000..8e352051aa --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerService.mdx @@ -0,0 +1,1208 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomerService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).CustomerService + +Provides layer to manipulate customers. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "addressRepository_", + "type": "`Repository`<[`Address`](admin_collections.internal.Address.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customerRepository_", + "type": "`Repository`<[`Customer`](admin_collections.internal.Customer.mdx)\\> & { `listAndCount`: Method listAndCount }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBusService_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "retrieve_", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PASSWORD_RESET", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addAddress + +▸ **addAddress**(`customerId`, `address`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx) \| [`Address`](admin_collections.internal.Address.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Customer`](admin_collections.internal.Customer.mdx) \| [`Address`](admin_collections.internal.Address.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Customer \\| Address", + "type": "[`Customer`](admin_collections.internal.Customer.mdx) \\| [`Address`](admin_collections.internal.Address.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### count + +▸ **count**(): `Promise`<`number`\> + +Return the total number of documents in database + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the count operation", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`customer`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of create", + "children": [ + { + "name": "Customer", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`customerId`): `Promise`<`void` \| [`Customer`](admin_collections.internal.Customer.mdx)\> + +Deletes a customer from a given customer id. + +#### Parameters + + + +#### Returns + +`Promise`<`void` \| [`Customer`](admin_collections.internal.Customer.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the delete operation.", + "children": [ + { + "name": "void \\| Customer", + "type": "`void` \\| [`Customer`](admin_collections.internal.Customer.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`string`\> + +", + "optional": false, + "defaultValue": "", + "description": "the generated JSON web token", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### hashPassword\_ + +▸ **hashPassword_**(`password`): `Promise`<`string`\> + +Hashes a password + +#### Parameters + + + +#### Returns + +`Promise`<`string`\> + +", + "optional": false, + "defaultValue": "", + "description": "hashed password", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)[]\> + +#### Parameters + + & { `groups?`: `string`[] ; `q?`: `string` }", + "description": "the query object for find", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Customer`](admin_collections.internal.Customer.mdx)\\>", + "description": "the config object containing query settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Customer`](admin_collections.internal.Customer.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "Customer[]", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Customer", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Customer`](admin_collections.internal.Customer.mdx)[], `number`]\> + +#### Parameters + + & { `groups?`: `string`[] ; `q?`: `string` }", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Customer`](admin_collections.internal.Customer.mdx)\\>", + "description": "the config object containing query settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`Customer`](admin_collections.internal.Customer.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "Customer[]", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### listByEmail + +▸ **listByEmail**(`email`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)[]\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Customer`](admin_collections.internal.Customer.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Customer[]", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Customer", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### removeAddress + +▸ **removeAddress**(`customerId`, `addressId`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`customerId`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +Gets a customer by id. + +#### Parameters + +", + "description": "the config object containing query settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the customer document.", + "children": [ + { + "name": "Customer", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByEmail + +▸ **retrieveByEmail**(`email`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +Gets a registered customer by email. + +#### Parameters + +", + "description": "the config object containing query settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the customer document.", + "children": [ + { + "name": "Customer", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +___ + +### retrieveByPhone + +▸ **retrieveByPhone**(`phone`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +Gets a customer by phone. + +#### Parameters + +", + "description": "the config object containing query settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the customer document.", + "children": [ + { + "name": "Customer", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveRegisteredByEmail + +▸ **retrieveRegisteredByEmail**(`email`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Customer", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveUnregisteredByEmail + +▸ **retrieveUnregisteredByEmail**(`email`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Customer", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`customerId`, `update`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +Updates a customer. + +#### Parameters + + + +#### Returns + +`Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the update result.", + "children": [ + { + "name": "Customer", + "type": "[`Customer`](admin_collections.internal.Customer.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateAddress + +▸ **updateAddress**(`customerId`, `addressId`, `address`): `Promise`<[`Address`](admin_collections.internal.Address.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Address`](admin_collections.internal.Address.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Address", + "type": "[`Address`](admin_collections.internal.Address.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateBillingAddress\_ + +▸ **updateBillingAddress_**(`customer`, `addressOrId`): `Promise`<`void`\> + +Updates the customers' billing address. + +#### Parameters + +", + "description": "the value to set the billing address to", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`CustomerService`](admin_discounts.internal.internal.CustomerService.mdx) + +#### Parameters + + + +#### Returns + +[`CustomerService`](admin_discounts.internal.internal.CustomerService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx new file mode 100644 index 0000000000..17d5859a9f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionCustomerGroup + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).DiscountConditionCustomerGroup + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProduct.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProduct.mdx new file mode 100644 index 0000000000..60edaa2671 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProduct.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionProduct + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).DiscountConditionProduct + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProductCollection.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProductCollection.mdx new file mode 100644 index 0000000000..cafab78401 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProductCollection.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionProductCollection + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).DiscountConditionProductCollection + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_collection", + "type": "[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProductTag.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProductTag.mdx new file mode 100644 index 0000000000..2cdf35b1a9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProductTag.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionProductTag + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).DiscountConditionProductTag + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_tag", + "type": "[`ProductTag`](admin_collections.internal.ProductTag.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_tag_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProductType.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProductType.mdx new file mode 100644 index 0000000000..22fe645033 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionProductType.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionProductType + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).DiscountConditionProductType + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_type", + "type": "[`ProductType`](admin_collections.internal.ProductType.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_type_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionService.mdx new file mode 100644 index 0000000000..b20987ac88 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionService.mdx @@ -0,0 +1,474 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).DiscountConditionService + +Provides layer to manipulate discount conditions. + +#### Implements + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discountConditionRepository_", + "type": "`Repository`<[`DiscountCondition`](admin_collections.internal.DiscountCondition.mdx)\\> & { `addConditionResources`: Method addConditionResources ; `canApplyForCustomer`: Method canApplyForCustomer ; `findOneWithDiscount`: Method findOneWithDiscount ; `getJoinTableResourceIdentifiers`: Method getJoinTableResourceIdentifiers ; `isValidForProduct`: Method isValidForProduct ; `queryConditionTable`: Method queryConditionTable ; `removeConditionResources`: Method removeConditionResources }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### delete + +▸ **delete**(`discountConditionId`): `Promise`<`void` \| [`DiscountCondition`](admin_collections.internal.DiscountCondition.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<`void` \| [`DiscountCondition`](admin_collections.internal.DiscountCondition.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "void \\| DiscountCondition", + "type": "`void` \\| [`DiscountCondition`](admin_collections.internal.DiscountCondition.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeResources + +▸ **removeResources**(`data`): `Promise`<`void`\> + +#### Parameters + + & { `id`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`conditionId`, `config?`): `Promise`<[`DiscountCondition`](admin_collections.internal.DiscountCondition.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`DiscountCondition`](admin_collections.internal.DiscountCondition.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DiscountCondition", + "type": "[`DiscountCondition`](admin_collections.internal.DiscountCondition.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### upsertCondition + +▸ **upsertCondition**(`data`, `overrideExisting?`): `Promise`<([`DiscountConditionCustomerGroup`](admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx) \| [`DiscountConditionProduct`](admin_discounts.internal.internal.DiscountConditionProduct.mdx) \| [`DiscountConditionProductCollection`](admin_discounts.internal.internal.DiscountConditionProductCollection.mdx) \| [`DiscountConditionProductTag`](admin_discounts.internal.internal.DiscountConditionProductTag.mdx) \| [`DiscountConditionProductType`](admin_discounts.internal.internal.DiscountConditionProductType.mdx))[]\> + +#### Parameters + + + +#### Returns + +`Promise`<([`DiscountConditionCustomerGroup`](admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx) \| [`DiscountConditionProduct`](admin_discounts.internal.internal.DiscountConditionProduct.mdx) \| [`DiscountConditionProductCollection`](admin_discounts.internal.internal.DiscountConditionProductCollection.mdx) \| [`DiscountConditionProductTag`](admin_discounts.internal.internal.DiscountConditionProductTag.mdx) \| [`DiscountConditionProductType`](admin_discounts.internal.internal.DiscountConditionProductType.mdx))[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "(DiscountConditionCustomerGroup \\| DiscountConditionProduct \\| DiscountConditionProductCollection \\| DiscountConditionProductTag \\| DiscountConditionProductType)[]", + "type": "([`DiscountConditionCustomerGroup`](admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx) \\| [`DiscountConditionProduct`](admin_discounts.internal.internal.DiscountConditionProduct.mdx) \\| [`DiscountConditionProductCollection`](admin_discounts.internal.internal.DiscountConditionProductCollection.mdx) \\| [`DiscountConditionProductTag`](admin_discounts.internal.internal.DiscountConditionProductTag.mdx) \\| [`DiscountConditionProductType`](admin_discounts.internal.internal.DiscountConditionProductType.mdx))[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DiscountConditionCustomerGroup \\| DiscountConditionProduct \\| DiscountConditionProductCollection \\| DiscountConditionProductTag \\| DiscountConditionProductType", + "type": "[`DiscountConditionCustomerGroup`](admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx) \\| [`DiscountConditionProduct`](admin_discounts.internal.internal.DiscountConditionProduct.mdx) \\| [`DiscountConditionProductCollection`](admin_discounts.internal.internal.DiscountConditionProductCollection.mdx) \\| [`DiscountConditionProductTag`](admin_discounts.internal.internal.DiscountConditionProductTag.mdx) \\| [`DiscountConditionProductType`](admin_discounts.internal.internal.DiscountConditionProductType.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`DiscountConditionService`](admin_discounts.internal.internal.DiscountConditionService.mdx) + +#### Parameters + + + +#### Returns + +[`DiscountConditionService`](admin_discounts.internal.internal.DiscountConditionService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) + +___ + +### resolveConditionType\_ + +▸ `Static` `Protected` **resolveConditionType_**(`data`): `undefined` \| { `resource_ids`: (`string` \| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/admin_collections.internal.DiscountConditionType.mdx) } + +#### Parameters + + + +#### Returns + +`undefined` \| { `resource_ids`: (`string` \| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/admin_collections.internal.DiscountConditionType.mdx) } + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountService.mdx new file mode 100644 index 0000000000..733bc1ee33 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountService.mdx @@ -0,0 +1,1419 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).DiscountService + +Provides layer to manipulate discounts. + +#### Implements + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "customerService_", + "type": "[`CustomerService`](admin_discounts.internal.internal.CustomerService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountConditionRepository_", + "type": "`Repository`<[`DiscountCondition`](admin_collections.internal.DiscountCondition.mdx)\\> & { `addConditionResources`: Method addConditionResources ; `canApplyForCustomer`: Method canApplyForCustomer ; `findOneWithDiscount`: Method findOneWithDiscount ; `getJoinTableResourceIdentifiers`: Method getJoinTableResourceIdentifiers ; `isValidForProduct`: Method isValidForProduct ; `queryConditionTable`: Method queryConditionTable ; `removeConditionResources`: Method removeConditionResources }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountConditionService_", + "type": "[`DiscountConditionService`](admin_discounts.internal.internal.DiscountConditionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountRepository_", + "type": "`Repository`<[`Discount`](admin_collections.internal.Discount.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountRuleRepository_", + "type": "`Repository`<[`DiscountRule`](admin_collections.internal.DiscountRule.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "giftCardRepository_", + "type": "`Repository`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\\> & { `listGiftCardsAndCount`: Method listGiftCardsAndCount }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "newTotalsService_", + "type": "[`NewTotalsService`](admin_discounts.internal.internal.NewTotalsService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productService_", + "type": "[`ProductService`](admin_discounts.internal.internal.ProductService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regionService_", + "type": "[`RegionService`](admin_discounts.internal.internal.RegionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "totalsService_", + "type": "[`TotalsService`](admin_discounts.internal.internal.TotalsService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addRegion + +▸ **addRegion**(`discountId`, `regionId`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +Adds a region to the discount regions array. + +#### Parameters + + + +#### Returns + +`Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "Discount", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### calculateDiscountForLineItem + +▸ **calculateDiscountForLineItem**(`discountId`, `lineItem`, `calculationContextData`): `Promise`<`number`\> + +#### Parameters + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### canApplyForCustomer + +▸ **canApplyForCustomer**(`discountRuleId`, `customerId`): `Promise`<`boolean`\> + +#### Parameters + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`discount`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +Creates a discount with provided data given that the data is validated. +Normalizes discount code to uppercase. + +#### Parameters + + + +#### Returns + +`Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the create operation", + "children": [ + { + "name": "Discount", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createDynamicCode + +▸ **createDynamicCode**(`discountId`, `data`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +Creates a dynamic code for a discount id. + +#### Parameters + + + +#### Returns + +`Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the newly created dynamic code", + "children": [ + { + "name": "Discount", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`discountId`): `Promise`<`void`\> + +Deletes a discount idempotently + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the delete operation", + "children": [] + } +]} /> + +___ + +### deleteDynamicCode + +▸ **deleteDynamicCode**(`discountId`, `code`): `Promise`<`void`\> + +Deletes a dynamic code for a discount id. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the newly created dynamic code", + "children": [] + } +]} /> + +___ + +### hasCustomersGroupCondition + +▸ **hasCustomersGroupCondition**(`discount`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### hasExpired + +▸ **hasExpired**(`discount`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### hasNotStarted + +▸ **hasNotStarted**(`discount`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### hasReachedLimit + +▸ **hasReachedLimit**(`discount`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### isDisabled + +▸ **isDisabled**(`discount`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### isValidForRegion + +▸ **isValidForRegion**(`discount`, `region_id`): `Promise`<`boolean`\> + +#### Parameters + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)[]\> + +#### Parameters + +", + "description": "the config object containing query settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Discount`](admin_collections.internal.Discount.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "Discount[]", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Discount", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`Discount`](admin_collections.internal.Discount.mdx)[], `number`]\> + +#### Parameters + +", + "description": "the config object containing query settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`Discount`](admin_collections.internal.Discount.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "Discount[]", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### listByCodes + +▸ **listByCodes**(`discountCodes`, `config?`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)[]\> + +List all the discounts corresponding to the given codes + +#### Parameters + +", + "description": "the config object containing query settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Discount`](admin_collections.internal.Discount.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the discounts", + "children": [ + { + "name": "Discount[]", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Discount", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### removeRegion + +▸ **removeRegion**(`discountId`, `regionId`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +Removes a region from the discount regions array. + +#### Parameters + + + +#### Returns + +`Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "Discount", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`discountId`, `config?`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +Gets a discount by id. + +#### Parameters + +", + "description": "the config object containing query settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the discount", + "children": [ + { + "name": "Discount", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByCode + +▸ **retrieveByCode**(`discountCode`, `config?`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +Gets the discount by discount code. + +#### Parameters + +", + "description": "the config object containing query settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the discount", + "children": [ + { + "name": "Discount", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`discountId`, `update`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +Updates a discount. + +#### Parameters + + + +#### Returns + +`Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "Discount", + "type": "[`Discount`](admin_collections.internal.Discount.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### validateDiscountForCartOrThrow + +▸ **validateDiscountForCartOrThrow**(`cart`, `discount`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### validateDiscountForProduct + +▸ **validateDiscountForProduct**(`discountRuleId`, `productId?`): `Promise`<`boolean`\> + +#### Parameters + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### validateDiscountRule\_ + +▸ **validateDiscountRule_**<`T`\>(`discountRule`): `T` + +Creates a discount rule with provided data given that the data is validated. + + + +#### Parameters + + + +#### Returns + +`T` + + + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`DiscountService`](admin_discounts.internal.internal.DiscountService.mdx) + +#### Parameters + + + +#### Returns + +[`DiscountService`](admin_discounts.internal.internal.DiscountService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DraftOrderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DraftOrderService.mdx new file mode 100644 index 0000000000..0f378ff40a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DraftOrderService.mdx @@ -0,0 +1,765 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DraftOrderService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).DraftOrderService + +Handles draft orders + +#### Implements + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "cartService_", + "type": "[`CartService`](admin_discounts.internal.internal.CartService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customShippingOptionService_", + "type": "[`CustomShippingOptionService`](admin_discounts.internal.internal.CustomShippingOptionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draftOrderRepository_", + "type": "`Repository`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemService_", + "type": "[`LineItemService`](admin_discounts.internal.internal.LineItemService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orderRepository_", + "type": "`Repository`<[`Order`](admin_collections.internal.Order.mdx)\\> & { `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentRepository_", + "type": "`Repository`<[`Payment`](admin_collections.internal.Payment.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantService_", + "type": "[`ProductVariantService`](admin_discounts.internal.internal.ProductVariantService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingOptionService_", + "type": "[`ShippingOptionService`](admin_discounts.internal.internal.ShippingOptionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`data`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> + +Creates a draft order. + +#### Parameters + + + +#### Returns + +`Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the created draft order", + "children": [ + { + "name": "DraftOrder", + "type": "[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`draftOrderId`): `Promise`<`undefined` \| [`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> + +Deletes draft order idempotently. + +#### Parameters + + + +#### Returns + +`Promise`<`undefined` \| [`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "empty promise", + "children": [ + { + "name": "undefined \\| DraftOrder", + "type": "`undefined` \\| [`DraftOrder`](admin_collections.internal.DraftOrder.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)[]\> + +Lists draft orders + +#### Parameters + +", + "description": "configurable attributes for find", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "list of draft orders", + "children": [ + { + "name": "DraftOrder[]", + "type": "[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "DraftOrder", + "type": "[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)[], `number`]\> + +Lists draft orders alongside the count + +#### Parameters + +", + "description": "query config", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "draft orders", + "children": [ + { + "name": "DraftOrder[]", + "type": "[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### registerCartCompletion + +▸ **registerCartCompletion**(`draftOrderId`, `orderId`): `Promise`<`UpdateResult`\> + +Registers a draft order as completed, when an order has been completed. + +#### Parameters + + + +#### Returns + +`Promise`<`UpdateResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the created order", + "children": [ + { + "name": "UpdateResult", + "type": "`UpdateResult`", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`draftOrderId`, `config?`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> + +Retrieves a draft order with the given id. + +#### Parameters + +", + "description": "query object for findOne", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the draft order", + "children": [ + { + "name": "DraftOrder", + "type": "[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByCartId + +▸ **retrieveByCartId**(`cartId`, `config?`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> + +Retrieves a draft order based on its associated cart id + +#### Parameters + +", + "description": "query object for findOne", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the draft order", + "children": [ + { + "name": "DraftOrder", + "type": "[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`id`, `data`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> + +Updates a draft order with the given data + +#### Parameters + + + +#### Returns + +`Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated draft order", + "children": [ + { + "name": "DraftOrder", + "type": "[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`DraftOrderService`](admin_discounts.internal.internal.DraftOrderService.mdx) + +#### Parameters + + + +#### Returns + +[`DraftOrderService`](admin_discounts.internal.internal.DraftOrderService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.EmptyQueryParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.EmptyQueryParams.mdx new file mode 100644 index 0000000000..8fe6beec9f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.EmptyQueryParams.mdx @@ -0,0 +1,9 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# EmptyQueryParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).EmptyQueryParams diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.EventBusService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.EventBusService.mdx new file mode 100644 index 0000000000..ef944ee3b8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.EventBusService.mdx @@ -0,0 +1,641 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# EventBusService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).EventBusService + +Can keep track of multiple subscribers to different events and run the +subscribers when events happen. Events will run asynchronously. + +## Implements + +- [`IEventBusService`](../interfaces/admin_discounts.internal.IEventBusService.mdx) + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config_", + "type": "[`ConfigModule`](../../admin_discounts/modules/admin_discounts.internal.mdx#configmodule)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "enqueue_", + "type": "`Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBusModuleService_", + "type": "[`IEventBusModuleService`](../interfaces/admin_discounts.internal.IEventBusModuleService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "logger_", + "type": "[`Logger`](../interfaces/admin_discounts.internal.Logger.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shouldEnqueuerRun", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "stagedJobService_", + "type": "[`StagedJobService`](admin_discounts.internal.internal.StagedJobService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### emit + +▸ **emit**<`T`\>(`data`): `Promise`<`void` \| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> + +Calls all subscribers when an event occurs. + + + +#### Parameters + +[]", + "description": "The data to use to process the events", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void` \| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the jobs from our queue", + "children": [ + { + "name": "void \\| StagedJob[]", + "type": "`void` \\| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +[IEventBusService](../interfaces/admin_discounts.internal.IEventBusService.mdx).[emit](../interfaces/admin_discounts.internal.IEventBusService.mdx#emit) + +▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)\> + +Calls all subscribers when an event occurs. + + + +#### Parameters + +", + "description": "options to add the job with", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void` \| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the job from our queue", + "children": [ + { + "name": "void \\| StagedJob", + "type": "`void` \\| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Implementation of + +EventBusTypes.IEventBusService.emit + +___ + +### enqueuer\_ + +▸ **enqueuer_**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### listJobs + +▸ `Protected` **listJobs**(`listConfig`): `Promise`<`never`[] \| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`never`[] \| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "never[] \\| StagedJob[]", + "type": "`never`[] \\| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### startEnqueuer + +▸ **startEnqueuer**(): `void` + +#### Returns + +`void` + + + +___ + +### stopEnqueuer + +▸ **stopEnqueuer**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### subscribe + +▸ **subscribe**(`event`, `subscriber`, `context?`): [`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx) + +Adds a function to a list of event subscribers. + +#### Parameters + +", + "description": "the function to be called when a certain event happens. Subscribers must return a Promise.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`SubscriberContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscribercontext)", + "description": "subscriber context", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx) + + + +#### Implementation of + +[IEventBusService](../interfaces/admin_discounts.internal.IEventBusService.mdx).[subscribe](../interfaces/admin_discounts.internal.IEventBusService.mdx#subscribe) + +___ + +### unsubscribe + +▸ **unsubscribe**(`event`, `subscriber`, `context`): [`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx) + +Removes function from the list of event subscribers. + +#### Parameters + +", + "description": "the function to be removed", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`SubscriberContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscribercontext)", + "description": "subscriber context", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx) + + + +#### Implementation of + +[IEventBusService](../interfaces/admin_discounts.internal.IEventBusService.mdx).[unsubscribe](../interfaces/admin_discounts.internal.IEventBusService.mdx#unsubscribe) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx) + +#### Parameters + + + +#### Returns + +[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx) + + + +#### Implementation of + +[IEventBusService](../interfaces/admin_discounts.internal.IEventBusService.mdx).[withTransaction](../interfaces/admin_discounts.internal.IEventBusService.mdx#withtransaction) + +#### Overrides + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FilterableBatchJobProps.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FilterableBatchJobProps.mdx new file mode 100644 index 0000000000..3ba2bc4ca3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FilterableBatchJobProps.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterableBatchJobProps + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).FilterableBatchJobProps + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FilterablePriceListProps.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FilterablePriceListProps.mdx new file mode 100644 index 0000000000..bb1d8f40e6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FilterablePriceListProps.mdx @@ -0,0 +1,94 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterablePriceListProps + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).FilterablePriceListProps + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FulfillmentOption.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FulfillmentOption.mdx new file mode 100644 index 0000000000..f2358e665c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FulfillmentOption.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FulfillmentOption + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).FulfillmentOption + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FulfillmentProviderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FulfillmentProviderService.mdx new file mode 100644 index 0000000000..433cf486d5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FulfillmentProviderService.mdx @@ -0,0 +1,878 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FulfillmentProviderService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).FulfillmentProviderService + +Helps retrieve fulfillment providers + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "container_", + "type": "[`FulfillmentProviderContainer`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentprovidercontainer)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillmentProviderRepository_", + "type": "`Repository`<[`FulfillmentProvider`](admin_collections.internal.FulfillmentProvider.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### calculatePrice + +▸ **calculatePrice**(`option`, `data`, `cart?`): `Promise`<`number`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Order`](admin_collections.internal.Order.mdx) \\| [`Cart`](admin_collections.internal.Cart.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### canCalculate + +▸ **canCalculate**(`option`): `Promise`<`boolean`\> + +#### Parameters + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`fulfillment`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Fulfillment", + "type": "[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createFulfillment + +▸ **createFulfillment**(`method`, `items`, `order`, `fulfillment`): `Promise`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### createReturn + +▸ **createReturn**(`returnOrder`): `Promise`\> + +#### Parameters + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(): `Promise`<[`FulfillmentProvider`](admin_collections.internal.FulfillmentProvider.mdx)[]\> + +#### Returns + +`Promise`<[`FulfillmentProvider`](admin_collections.internal.FulfillmentProvider.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "FulfillmentProvider[]", + "type": "[`FulfillmentProvider`](admin_collections.internal.FulfillmentProvider.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "FulfillmentProvider", + "type": "[`FulfillmentProvider`](admin_collections.internal.FulfillmentProvider.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listFulfillmentOptions + +▸ **listFulfillmentOptions**(`providerIds`): `Promise`<[`FulfillmentOptions`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentoptions)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`FulfillmentOptions`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentoptions)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "FulfillmentOptions[]", + "type": "[`FulfillmentOptions`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentoptions)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "FulfillmentOptions", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### registerInstalledProviders + +▸ **registerInstalledProviders**(`providers`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### retrieveDocuments + +▸ **retrieveDocuments**(`providerId`, `fulfillmentData`, `documentType`): `Promise`<`any`\> + +Fetches documents from the fulfillment provider + +#### Parameters + +", + "description": "the data relating to the fulfillment", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "documentType", + "type": "``\"label\"`` \\| ``\"invoice\"``", + "description": "the typ of", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "document to fetch", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveProvider + +▸ **retrieveProvider**(`providerId`): `any` + +#### Parameters + + + +#### Returns + +`any` + + + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### validateFulfillmentData + +▸ **validateFulfillmentData**(`option`, `data`, `cart`): `Promise`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "Record<`string`, `unknown`\\> \\| [`Cart`](admin_collections.internal.Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### validateOption + +▸ **validateOption**(`option`): `Promise`<`boolean`\> + +#### Parameters + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`FulfillmentProviderService`](admin_discounts.internal.internal.FulfillmentProviderService.mdx) + +#### Parameters + + + +#### Returns + +[`FulfillmentProviderService`](admin_discounts.internal.internal.FulfillmentProviderService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetOrderEditsOrderEditParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetOrderEditsOrderEditParams.mdx new file mode 100644 index 0000000000..c7d129dae5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetOrderEditsOrderEditParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# GetOrderEditsOrderEditParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).GetOrderEditsOrderEditParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetOrderEditsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetOrderEditsParams.mdx new file mode 100644 index 0000000000..4464fe541a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetOrderEditsParams.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# GetOrderEditsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).GetOrderEditsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetPaymentsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetPaymentsParams.mdx new file mode 100644 index 0000000000..8362132390 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetPaymentsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# GetPaymentsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).GetPaymentsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetPublishableApiKeySalesChannelsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetPublishableApiKeySalesChannelsParams.mdx new file mode 100644 index 0000000000..402be9061c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetPublishableApiKeySalesChannelsParams.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# GetPublishableApiKeySalesChannelsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).GetPublishableApiKeySalesChannelsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetPublishableApiKeysParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetPublishableApiKeysParams.mdx new file mode 100644 index 0000000000..b01f6fdc61 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GetPublishableApiKeysParams.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# GetPublishableApiKeysParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).GetPublishableApiKeysParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GiftCardService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GiftCardService.mdx new file mode 100644 index 0000000000..24e81b90ce --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GiftCardService.mdx @@ -0,0 +1,810 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# GiftCardService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).GiftCardService + +Provides layer to manipulate gift cards. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "giftCardRepository_", + "type": "`Repository`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\\> & { `listGiftCardsAndCount`: Method listGiftCardsAndCount }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "giftCardTransactionRepo_", + "type": "`Repository`<[`GiftCardTransaction`](admin_collections.internal.GiftCardTransaction.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regionService_", + "type": "[`RegionService`](admin_discounts.internal.internal.RegionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`giftCard`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> + +Creates a gift card with provided data given that the data is validated. + +#### Parameters + + + +#### Returns + +`Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the create operation", + "children": [ + { + "name": "GiftCard", + "type": "[`GiftCard`](admin_collections.internal.GiftCard.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createTransaction + +▸ **createTransaction**(`data`): `Promise`<`string`\> + +#### Parameters + + + +#### Returns + +`Promise`<`string`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`giftCardId`): `Promise`<`void` \| [`GiftCard`](admin_collections.internal.GiftCard.mdx)\> + +Deletes a gift card idempotently + +#### Parameters + + + +#### Returns + +`Promise`<`void` \| [`GiftCard`](admin_collections.internal.GiftCard.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the delete operation", + "children": [ + { + "name": "void \\| GiftCard", + "type": "`void` \\| [`GiftCard`](admin_collections.internal.GiftCard.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)[]\> + +#### Parameters + +", + "description": "the query object for find", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\\>", + "description": "the configuration used to find the objects. contains relations, skip, and take.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "GiftCard[]", + "type": "[`GiftCard`](admin_collections.internal.GiftCard.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "GiftCard", + "type": "[`GiftCard`](admin_collections.internal.GiftCard.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`GiftCard`](admin_collections.internal.GiftCard.mdx)[], `number`]\> + +#### Parameters + +", + "description": "the query object for find", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\\>", + "description": "the configuration used to find the objects. contains relations, skip, and take.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`GiftCard`](admin_collections.internal.GiftCard.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "GiftCard[]", + "type": "[`GiftCard`](admin_collections.internal.GiftCard.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`giftCardId`, `config?`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> + +Gets a gift card by id. + +#### Parameters + +", + "description": "optional values to include with gift card query", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the gift card", + "children": [ + { + "name": "GiftCard", + "type": "[`GiftCard`](admin_collections.internal.GiftCard.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByCode + +▸ **retrieveByCode**(`code`, `config?`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "GiftCard", + "type": "[`GiftCard`](admin_collections.internal.GiftCard.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve\_ + +▸ `Protected` **retrieve_**(`selector`, `config?`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "GiftCard", + "type": "[`GiftCard`](admin_collections.internal.GiftCard.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`giftCardId`, `update`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> + +Updates a giftCard. + +#### Parameters + + + +#### Returns + +`Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "GiftCard", + "type": "[`GiftCard`](admin_collections.internal.GiftCard.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`GiftCardService`](admin_discounts.internal.internal.GiftCardService.mdx) + +#### Parameters + + + +#### Returns + +[`GiftCardService`](admin_discounts.internal.internal.GiftCardService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) + +___ + +### generateCode + +▸ `Static` **generateCode**(): `string` + +Generates a 16 character gift card code + +#### Returns + +`string` + + + +___ + +### 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 + + + +#### Returns + +``null`` \| `number` + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IAdminPostUploadsFileReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IAdminPostUploadsFileReq.mdx new file mode 100644 index 0000000000..40b9da4fc0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IAdminPostUploadsFileReq.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IAdminPostUploadsFileReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).IAdminPostUploadsFileReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IdempotencyKey.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IdempotencyKey.mdx new file mode 100644 index 0000000000..dd5d84c54c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IdempotencyKey.mdx @@ -0,0 +1,102 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IdempotencyKey + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).IdempotencyKey + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "request_path", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "response_body", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "response_code", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IdempotencyKeyService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IdempotencyKeyService.mdx new file mode 100644 index 0000000000..2a95a970fb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IdempotencyKeyService.mdx @@ -0,0 +1,556 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IdempotencyKeyService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).IdempotencyKeyService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotencyKeyRepository_", + "type": "`Repository`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`payload`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> + +Creates an idempotency key for a request. +If no idempotency key is provided in request, we will create a unique +identifier. + +#### Parameters + + + +#### Returns + +`Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the created idempotency key", + "children": [ + { + "name": "IdempotencyKey", + "type": "[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### initializeRequest + +▸ **initializeRequest**(`headerKey`, `reqMethod`, `reqParams`, `reqPath`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> + +Execute the initial steps in a idempotent request. + +#### Parameters + +", + "description": "params of request", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reqPath", + "type": "`string`", + "description": "path of request", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the existing or created idempotency key", + "children": [ + { + "name": "IdempotencyKey", + "type": "[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### lock + +▸ **lock**(`idempotencyKey`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> + +Locks an idempotency. + +#### Parameters + + + +#### Returns + +`Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "result of the update operation", + "children": [ + { + "name": "IdempotencyKey", + "type": "[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`idempotencyKeyOrSelector`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> + +Retrieves an idempotency key + +#### Parameters + +", + "description": "key or selector to retrieve", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "idempotency key", + "children": [ + { + "name": "IdempotencyKey", + "type": "[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`idempotencyKey`, `update`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> + +Locks an idempotency. + +#### Parameters + +", + "description": "update object", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "result of the update operation", + "children": [ + { + "name": "IdempotencyKey", + "type": "[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`IdempotencyKeyService`](admin_discounts.internal.internal.IdempotencyKeyService.mdx) + +#### Parameters + + + +#### Returns + +[`IdempotencyKeyService`](admin_discounts.internal.internal.IdempotencyKeyService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) + +___ + +### workStage + +▸ **workStage**(`idempotencyKey`, `callback`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> + +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 + + `Promise`<[`IdempotencyCallbackResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#idempotencycallbackresult)\\>", + "description": "functionality to execute within the phase", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "new updated idempotency key", + "children": [ + { + "name": "IdempotencyKey", + "type": "[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Invite.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Invite.mdx new file mode 100644 index 0000000000..b71ae7bcd5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Invite.mdx @@ -0,0 +1,104 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Invite + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).Invite + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "role", + "type": "[`UserRoles`](../enums/admin_auth.internal.UserRoles.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "token", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "user_email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Item.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Item.mdx new file mode 100644 index 0000000000..17f9990f1b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Item.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Item + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).Item + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemAdjustmentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemAdjustmentService.mdx new file mode 100644 index 0000000000..17c3bf6cd1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemAdjustmentService.mdx @@ -0,0 +1,684 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# LineItemAdjustmentService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).LineItemAdjustmentService + +Provides layer to manipulate line item adjustments. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discountService", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemAdjustmentRepo_", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`data`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)\> + +Creates a line item adjustment + +#### Parameters + +", + "description": "the line item adjustment to create", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "line item adjustment", + "children": [ + { + "name": "LineItemAdjustment", + "type": "[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createAdjustmentForLineItem + +▸ **createAdjustmentForLineItem**(`cart`, `lineItem`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[]\> + +Creates adjustment for a line item + +#### Parameters + + + +#### Returns + +`Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "a line item adjustment or undefined if no adjustment was created", + "children": [ + { + "name": "LineItemAdjustment[]", + "type": "[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "LineItemAdjustment", + "type": "[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### createAdjustments + +▸ **createAdjustments**(`cart`, `lineItem?`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[] \| [`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[][]\> + +Creates adjustment for a line item + +#### Parameters + + + +#### Returns + +`Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[] \| [`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[][]\> + +", + "optional": false, + "defaultValue": "", + "description": "if a lineItem was given, returns a line item adjustment or undefined if no adjustment was created\notherwise returns an array of line item adjustments for each line item in the cart", + "children": [ + { + "name": "LineItemAdjustment[] \\| LineItemAdjustment[][]", + "type": "[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[] \\| [`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[][]", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`selectorOrIds`): `Promise`<`void`\> + +Deletes line item adjustments matching a selector + +#### Parameters + + }", + "description": "the query object for find or the line item adjustment id", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the delete operation", + "children": [] + } +]} /> + +___ + +### generateAdjustments + +▸ **generateAdjustments**(`calculationContextData`, `generatedLineItem`, `context`): `Promise`<[`GeneratedAdjustment`](../../admin_discounts/modules/admin_discounts.internal.mdx#generatedadjustment)[]\> + +Creates adjustment for a line item + +#### Parameters + + + +#### Returns + +`Promise`<[`GeneratedAdjustment`](../../admin_discounts/modules/admin_discounts.internal.mdx#generatedadjustment)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "a line item adjustment or undefined if no adjustment was created", + "children": [ + { + "name": "GeneratedAdjustment[]", + "type": "[`GeneratedAdjustment`](../../admin_discounts/modules/admin_discounts.internal.mdx#generatedadjustment)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "GeneratedAdjustment", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[]\> + +Lists line item adjustments + +#### Parameters + +", + "description": "the config to be used for find", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "LineItemAdjustment[]", + "type": "[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "LineItemAdjustment", + "type": "[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`lineItemAdjustmentId`, `config?`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)\> + +Retrieves a line item adjustment by id. + +#### Parameters + +", + "description": "the config to retrieve the line item adjustment by", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the line item adjustment.", + "children": [ + { + "name": "LineItemAdjustment", + "type": "[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`id`, `data`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)\> + +Creates a line item adjustment + +#### Parameters + +", + "description": "the line item adjustment to create", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "line item adjustment", + "children": [ + { + "name": "LineItemAdjustment", + "type": "[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`LineItemAdjustmentService`](admin_discounts.internal.internal.LineItemAdjustmentService.mdx) + +#### Parameters + + + +#### Returns + +[`LineItemAdjustmentService`](admin_discounts.internal.internal.LineItemAdjustmentService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemService.mdx new file mode 100644 index 0000000000..83738f360d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemService.mdx @@ -0,0 +1,1081 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# LineItemService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).LineItemService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "cartRepository_", + "type": "`Repository`<[`Cart`](admin_collections.internal.Cart.mdx)\\> & { `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "itemTaxLineRepo_", + "type": "`Repository`<[`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx)\\> & { `deleteForCart`: Method deleteForCart ; `upsertLines`: Method upsertLines }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemAdjustmentService_", + "type": "[`LineItemAdjustmentService`](admin_discounts.internal.internal.LineItemAdjustmentService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemRepository_", + "type": "`Repository`<[`LineItem`](admin_collections.internal.LineItem.mdx)\\> & { `findByReturn`: Method findByReturn }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "pricingService_", + "type": "[`PricingService`](admin_discounts.internal.internal.PricingService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productService_", + "type": "[`ProductService`](admin_discounts.internal.internal.ProductService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantService_", + "type": "[`ProductVariantService`](admin_discounts.internal.internal.ProductVariantService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regionService_", + "type": "[`RegionService`](admin_discounts.internal.internal.RegionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxProviderService_", + "type": "[`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### cloneTo + +▸ **cloneTo**(`ids`, `data?`, `options?`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "`object`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "options.setOriginalLineItemId", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "LineItem[]", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "LineItem", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### create + +▸ **create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\> + +Create a line item + + + +#### Parameters + + + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the created line item", + "children": [] + } +]} /> + +___ + +### createReturnLines + +▸ **createReturnLines**(`returnId`, `cartId`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> + +Creates return line items for a given cart based on the return items in a +return. + +#### Parameters + + + +#### Returns + +`Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the created line items", + "children": [ + { + "name": "LineItem[]", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "LineItem", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### createTaxLine + +▸ **createTaxLine**(`args`): [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx) + +Create a line item tax line. + +#### Parameters + +", + "description": "tax line partial passed to the repo create method", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx) + + + +___ + +### delete + +▸ **delete**(`id`): `Promise`<`undefined` \| ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx)\> + +Deletes a line item. + +#### Parameters + + + +#### Returns + +`Promise`<`undefined` \| ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the delete operation", + "children": [ + { + "name": "undefined \\| ``null`` \\| LineItem", + "type": "`undefined` \\| ``null`` \\| [`LineItem`](admin_collections.internal.LineItem.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteWithTaxLines + +▸ **deleteWithTaxLines**(`id`): `Promise`<`undefined` \| ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<`undefined` \| ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the delete operation", + "children": [ + { + "name": "undefined \\| ``null`` \\| LineItem", + "type": "`undefined` \\| ``null`` \\| [`LineItem`](admin_collections.internal.LineItem.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +no the cascade on the entity takes care of it +Deletes a line item with the tax lines. + +___ + +### generate + +▸ **generate**<`T`, `TResult`\>(`variantIdOrData`, `regionIdOrContext`, `quantity?`, `context?`): `Promise`<`TResult`\> + +Generate a single or multiple line item without persisting the data into the db + + + +#### Parameters + + + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### generateLineItem + +▸ `Protected` **generateLineItem**(`variant`, `quantity`, `context`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "LineItem", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`LineItem`](admin_collections.internal.LineItem.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "LineItem[]", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "LineItem", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)\> + +Retrieves a line item by its id. + +#### Parameters + + + +#### Returns + +`Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the line item", + "children": [ + { + "name": "LineItem", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`idOrSelector`, `data`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> + +Updates a line item + +#### Parameters + +", + "description": "the id or selector of the line item(s) to update", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "[`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`LineItem`](admin_collections.internal.LineItem.mdx)\\>", + "description": "the properties to update the line item(s)", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated line item(s)", + "children": [ + { + "name": "LineItem[]", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "LineItem", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### validateGenerateArguments + +▸ `Protected` **validateGenerateArguments**<`T`, `TResult`\>(`variantIdOrData`, `regionIdOrContext`, `quantity?`): `void` + + + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`LineItemService`](admin_discounts.internal.internal.LineItemService.mdx) + +#### Parameters + + + +#### Returns + +[`LineItemService`](admin_discounts.internal.internal.LineItemService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.MiddlewareService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.MiddlewareService.mdx new file mode 100644 index 0000000000..66e755a493 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.MiddlewareService.mdx @@ -0,0 +1,420 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# MiddlewareService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).MiddlewareService + +Orchestrates dynamic middleware registered through the Medusa Middleware API + +## Properties + +\\>[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "routers", + "type": "Record<`string`, `Router`[]\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### addPostAuthentication + +▸ **addPostAuthentication**(`middleware`, `options`): `void` + +Adds a middleware function to be called after authentication is completed. + +#### Parameters + +", + "description": "the arguments that will be passed to the middleware", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### addPreAuthentication + +▸ **addPreAuthentication**(`middleware`, `options`): `void` + +Adds a middleware function to be called before authentication is completed. + +#### Parameters + +", + "description": "the arguments that will be passed to the middleware", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### addPreCartCreation + +▸ **addPreCartCreation**(`middleware`): `void` + +Adds a middleware function to be called before cart creation + +#### Parameters + +\\>", + "description": "the middleware function. Should return a middleware function.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### addRouter + +▸ **addRouter**(`path`, `router`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### getRouters + +▸ **getRouters**(`path`): `Router`[] + +#### Parameters + + + +#### Returns + +`Router`[] + + + +___ + +### usePostAuthentication + +▸ **usePostAuthentication**(`app`): `void` + +Adds post authentication middleware to an express app. + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### usePreAuthentication + +▸ **usePreAuthentication**(`app`): `void` + +Adds pre authentication middleware to an express app. + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### usePreCartCreation + +▸ **usePreCartCreation**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\>[] + +#### Returns + +`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\>[] + +\\>[]", + "type": "`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\\>\\>[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "RequestHandler", + "type": "`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\\>\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "Record", + "type": "Record<`string`, `any`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### validateMiddleware\_ + +▸ **validateMiddleware_**(`fn`): `void` + +Validates a middleware function, throws if fn is not of type function. + +#### Parameters + + + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NewTotalsService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NewTotalsService.mdx new file mode 100644 index 0000000000..c16319ea5c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NewTotalsService.mdx @@ -0,0 +1,1128 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# NewTotalsService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).NewTotalsService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxCalculationStrategy_", + "type": "[`ITaxCalculationStrategy`](../interfaces/admin_discounts.internal.internal.ITaxCalculationStrategy.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxProviderService_", + "type": "[`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### getGiftCardTotals + +▸ **getGiftCardTotals**(`giftCardableAmount`, `«destructured»`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\> + +Calculate and return the gift cards totals + +#### Parameters + + + +#### Returns + +`Promise`<{ `tax_total`: `number` ; `total`: `number` }\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "`object`", + "type": "`object`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getGiftCardTransactionsTotals + +▸ **getGiftCardTransactionsTotals**(`«destructured»`): { `tax_total`: `number` ; `total`: `number` } + +Calculate and return the gift cards totals based on their transactions + +#### Parameters + + + +#### Returns + +`object` + + + + + +___ + +### getLineItemRefund + +▸ **getLineItemRefund**(`lineItem`, `«destructured»`): `number` + +Return the amount that can be refund on a line item + +#### Parameters + + + +#### Returns + +`number` + + + +___ + +### getLineItemRefundLegacy + +▸ `Protected` **getLineItemRefundLegacy**(`lineItem`, `«destructured»`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +___ + +### getLineItemTotals + +▸ **getLineItemTotals**(`items`, `«destructured»`): `Promise`<{ `[lineItemId: string]`: [`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals); }\> + +Calculate and return the items totals for either the legacy calculation or the new calculation + +#### Parameters + + + +#### Returns + +`Promise`<{ `[lineItemId: string]`: [`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals); }\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "`object`", + "type": "`object`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getLineItemTotalsLegacy + +▸ `Protected` **getLineItemTotalsLegacy**(`item`, `«destructured»`): `Promise`<[`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals)\> + +Calculate and return the legacy calculated totals using the tax rate + +#### Parameters + + + +#### Returns + +`Promise`<[`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "LineItemTotals", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### getLineItemTotals\_ + +▸ `Protected` **getLineItemTotals_**(`item`, `«destructured»`): `Promise`<[`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals)\> + +Calculate and return the totals for an item + +#### Parameters + + + +#### Returns + +`Promise`<[`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "LineItemTotals", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### getShippingMethodTotals + +▸ **getShippingMethodTotals**(`shippingMethods`, `«destructured»`): `Promise`<{ `[shippingMethodId: string]`: [`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals); }\> + +Calculate and return the shipping methods totals for either the legacy calculation or the new calculation + +#### Parameters + + + +#### Returns + +`Promise`<{ `[shippingMethodId: string]`: [`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals); }\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "`object`", + "type": "`object`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getShippingMethodTotalsLegacy + +▸ `Protected` **getShippingMethodTotalsLegacy**(`shippingMethod`, `«destructured»`): `Promise`<[`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals)\> + +Calculate and return the shipping method totals legacy using the tax rate + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingMethodTotals", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### getShippingMethodTotals\_ + +▸ `Protected` **getShippingMethodTotals_**(`shippingMethod`, `«destructured»`): `Promise`<[`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals)\> + +Calculate and return the shipping method totals + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingMethodTotals", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`NewTotalsService`](admin_discounts.internal.internal.NewTotalsService.mdx) + +#### Parameters + + + +#### Returns + +[`NewTotalsService`](admin_discounts.internal.internal.NewTotalsService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Note.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Note.mdx new file mode 100644 index 0000000000..412b989091 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Note.mdx @@ -0,0 +1,104 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Note + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).Note + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NoteService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NoteService.mdx new file mode 100644 index 0000000000..8baad27466 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NoteService.mdx @@ -0,0 +1,606 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# NoteService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).NoteService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "noteRepository_", + "type": "`Repository`<[`Note`](admin_discounts.internal.internal.Note.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.DELETED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`data`, `config?`): `Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)\> + +Creates a note associated with a given author + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the creation result", + "children": [ + { + "name": "Note", + "type": "[`Note`](admin_discounts.internal.internal.Note.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`noteId`): `Promise`<`void`\> + +Deletes a given note + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)[]\> + +Fetches all notes related to the given selector + +#### Parameters + +", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Note`](admin_discounts.internal.internal.Note.mdx)\\>", + "description": "the configuration used to find the objects. contains relations, skip, and take.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "notes related to the given search.", + "children": [ + { + "name": "Note[]", + "type": "[`Note`](admin_discounts.internal.internal.Note.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Note", + "type": "[`Note`](admin_discounts.internal.internal.Note.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Note`](admin_discounts.internal.internal.Note.mdx)[], `number`]\> + +Fetches all notes related to the given selector + +#### Parameters + +", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Note`](admin_discounts.internal.internal.Note.mdx)\\>", + "description": "the configuration used to find the objects. contains relations, skip, and take.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`Note`](admin_discounts.internal.internal.Note.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "notes related to the given search.", + "children": [ + { + "name": "Note[]", + "type": "[`Note`](admin_discounts.internal.internal.Note.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`noteId`, `config?`): `Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)\> + +Retrieves a specific note. + +#### Parameters + +", + "description": "any options needed to query for the result.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "which resolves to the requested note.", + "children": [ + { + "name": "Note", + "type": "[`Note`](admin_discounts.internal.internal.Note.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`noteId`, `value`): `Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)\> + +Updates a given note with a new value + +#### Parameters + + + +#### Returns + +`Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the updated element", + "children": [ + { + "name": "Note", + "type": "[`Note`](admin_discounts.internal.internal.Note.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`NoteService`](admin_discounts.internal.internal.NoteService.mdx) + +#### Parameters + + + +#### Returns + +[`NoteService`](admin_discounts.internal.internal.NoteService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Notification.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Notification.mdx new file mode 100644 index 0000000000..3b7e93dbae --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Notification.mdx @@ -0,0 +1,144 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Notification + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).Notification + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "event_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_notification", + "type": "[`Notification`](admin_discounts.internal.internal.Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`NotificationProvider`](admin_discounts.internal.NotificationProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resends", + "type": "[`Notification`](admin_discounts.internal.internal.Notification.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "to", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NotificationService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NotificationService.mdx new file mode 100644 index 0000000000..8008fb8866 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NotificationService.mdx @@ -0,0 +1,781 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# NotificationService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).NotificationService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "attachmentGenerator_", + "type": "`unknown`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "container_", + "type": "[`InjectedDependencies`](../../admin_discounts/modules/admin_discounts.internal.mdx#injecteddependencies-16) & {}", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "logger_", + "type": "[`Logger`](../modules/admin_discounts.internal.internal.mdx#logger)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "notificationProviderRepository_", + "type": "`Repository`<[`NotificationProvider`](admin_discounts.internal.NotificationProvider.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "notificationRepository_", + "type": "`Repository`<[`Notification`](admin_discounts.internal.internal.Notification.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subscribers_", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### handleEvent + +▸ **handleEvent**(`eventName`, `data`): `Promise`<`undefined` \| `void` \| [`Notification`](admin_discounts.internal.internal.Notification.mdx)[]\> + +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 + +", + "description": "the data the event was sent with", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`undefined` \| `void` \| [`Notification`](admin_discounts.internal.internal.Notification.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of notification subscribed", + "children": [ + { + "name": "undefined \\| void \\| Notification[]", + "type": "`undefined` \\| `void` \\| [`Notification`](admin_discounts.internal.internal.Notification.mdx)[]", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Notification`](admin_discounts.internal.internal.Notification.mdx)[]\> + +Retrieves a list of notifications. + +#### Parameters + +", + "description": "the params to select the notifications by.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Notification`](admin_discounts.internal.internal.Notification.mdx)\\>", + "description": "the configuration to apply to the query", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Notification`](admin_discounts.internal.internal.Notification.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the notifications that satisfy the query.", + "children": [ + { + "name": "Notification[]", + "type": "[`Notification`](admin_discounts.internal.internal.Notification.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Notification", + "type": "[`Notification`](admin_discounts.internal.internal.Notification.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Notification`](admin_discounts.internal.internal.Notification.mdx)[], `number`]\> + +Retrieves a list of notifications and total count. + +#### Parameters + +", + "description": "the params to select the notifications by.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Notification`](admin_discounts.internal.internal.Notification.mdx)\\>", + "description": "the configuration to apply to the query", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`Notification`](admin_discounts.internal.internal.Notification.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "the notifications that satisfy the query as well as the count.", + "children": [ + { + "name": "Notification[]", + "type": "[`Notification`](admin_discounts.internal.internal.Notification.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`void` + + + +___ + +### registerInstalledProviders + +▸ **registerInstalledProviders**(`providerIds`): `Promise`<`void`\> + +Takes a list of notification provider ids and persists them in the database. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### resend + +▸ **resend**(`id`, `config?`): `Promise`<[`Notification`](admin_discounts.internal.internal.Notification.mdx)\> + +Resends a notification by retrieving a prior notification and calling the +underlying provider's resendNotification method. + +#### Parameters + +", + "description": "any configuration that might override the previous send", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Notification`](admin_discounts.internal.internal.Notification.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the newly created notification", + "children": [ + { + "name": "Notification", + "type": "[`Notification`](admin_discounts.internal.internal.Notification.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`): `Promise`<[`Notification`](admin_discounts.internal.internal.Notification.mdx)\> + +Retrieves a notification with a given id + +#### Parameters + +", + "description": "the configuration to apply to the query", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Notification`](admin_discounts.internal.internal.Notification.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the notification", + "children": [ + { + "name": "Notification", + "type": "[`Notification`](admin_discounts.internal.internal.Notification.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveProvider\_ + +▸ `Protected` **retrieveProvider_**(`id`): [`AbstractNotificationService`](admin_discounts.internal.internal.AbstractNotificationService.mdx) + +Finds a provider with a given id. Will throw a NOT_FOUND error if the +resolution fails. + +#### Parameters + + + +#### Returns + +[`AbstractNotificationService`](admin_discounts.internal.internal.AbstractNotificationService.mdx) + + + +___ + +### send + +▸ **send**(`event`, `eventData`, `providerId`): `Promise`<`undefined` \| [`Notification`](admin_discounts.internal.internal.Notification.mdx)\> + +Sends a notification, by calling the given provider's sendNotification +method. Persists the Notification in the database. + +#### Parameters + +", + "description": "the data the event was sent with", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "providerId", + "type": "`string`", + "description": "the provider that should handle the event.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`undefined` \| [`Notification`](admin_discounts.internal.internal.Notification.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the created notification", + "children": [ + { + "name": "undefined \\| Notification", + "type": "`undefined` \\| [`Notification`](admin_discounts.internal.internal.Notification.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### subscribe + +▸ **subscribe**(`eventName`, `providerId`): `void` + +Subscribes a given provider to an event. + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`NotificationService`](admin_discounts.internal.internal.NotificationService.mdx) + +#### Parameters + + + +#### Returns + +[`NotificationService`](admin_discounts.internal.internal.NotificationService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NumericalComparisonOperator.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NumericalComparisonOperator.mdx new file mode 100644 index 0000000000..fd44fc7b6e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NumericalComparisonOperator.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# NumericalComparisonOperator + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).NumericalComparisonOperator + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Oauth.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Oauth.mdx new file mode 100644 index 0000000000..10def6d29f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Oauth.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Oauth + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).Oauth + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "install_url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "uninstall_url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OauthService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OauthService.mdx new file mode 100644 index 0000000000..f58fd88b68 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OauthService.mdx @@ -0,0 +1,657 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OauthService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).OauthService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "container_", + "type": "[`InjectedDependencies`](../../admin_discounts/modules/admin_discounts.internal.mdx#injecteddependencies-17)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "oauthRepository_", + "type": "`Repository`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.TOKEN_GENERATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.TOKEN_REFRESHED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`data`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Oauth", + "type": "[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### generateToken + +▸ **generateToken**(`appName`, `code`, `state`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Oauth", + "type": "[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)[]\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Oauth[]", + "type": "[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Oauth", + "type": "[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### refreshToken + +▸ **refreshToken**(`appName`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Oauth", + "type": "[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### registerOauthApp + +▸ **registerOauthApp**(`appDetails`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Oauth", + "type": "[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`oauthId`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Oauth", + "type": "[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByName + +▸ **retrieveByName**(`appName`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Oauth", + "type": "[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`id`, `update`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Oauth", + "type": "[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`OauthService`](admin_discounts.internal.internal.OauthService.mdx) + +#### Parameters + + + +#### Returns + +[`OauthService`](admin_discounts.internal.internal.OauthService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditItemChangeService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditItemChangeService.mdx new file mode 100644 index 0000000000..a16c6a3629 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditItemChangeService.mdx @@ -0,0 +1,476 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderEditItemChangeService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).OrderEditItemChangeService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`IEventBusService`](../interfaces/admin_discounts.internal.IEventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemService_", + "type": "[`LineItemService`](admin_discounts.internal.internal.LineItemService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orderItemChangeRepository_", + "type": "`Repository`<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxProviderService_", + "type": "[`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.DELETED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`data`): `Promise`<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderItemChange", + "type": "[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`itemChangeIds`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)[]\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderItemChange[]", + "type": "[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderItemChange", + "type": "[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`): `Promise`<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderItemChange", + "type": "[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`OrderEditItemChangeService`](admin_discounts.internal.internal.OrderEditItemChangeService.mdx) + +#### Parameters + + + +#### Returns + +[`OrderEditItemChangeService`](admin_discounts.internal.internal.OrderEditItemChangeService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditService.mdx new file mode 100644 index 0000000000..30762a1c50 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditService.mdx @@ -0,0 +1,1300 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderEditService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).OrderEditService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBusService_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventoryService_", + "type": "`undefined` \\| [`IInventoryService`](../interfaces/admin_discounts.internal.IInventoryService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemAdjustmentService_", + "type": "[`LineItemAdjustmentService`](admin_discounts.internal.internal.LineItemAdjustmentService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemService_", + "type": "[`LineItemService`](admin_discounts.internal.internal.LineItemService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "newTotalsService_", + "type": "[`NewTotalsService`](admin_discounts.internal.internal.NewTotalsService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orderEditItemChangeService_", + "type": "[`OrderEditItemChangeService`](admin_discounts.internal.internal.OrderEditItemChangeService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orderEditRepository_", + "type": "`Repository`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orderService_", + "type": "[`OrderService`](admin_discounts.internal.internal.OrderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxProviderService_", + "type": "[`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "totalsService_", + "type": "[`TotalsService`](admin_discounts.internal.internal.TotalsService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CANCELED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CONFIRMED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.DECLINED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.REQUESTED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isOrderEditActive", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addLineItem + +▸ **addLineItem**(`orderEditId`, `data`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### cancel + +▸ **cancel**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderEdit", + "type": "[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### confirm + +▸ **confirm**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderEdit", + "type": "[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`data`, `context`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderEdit", + "type": "[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### decline + +▸ **decline**(`orderEditId`, `context`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderEdit", + "type": "[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### decorateTotals + +▸ **decorateTotals**(`orderEdit`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderEdit", + "type": "[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`id`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### deleteClonedItems + +▸ `Protected` **deleteClonedItems**(`orderEditId`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### deleteItemChange + +▸ **deleteItemChange**(`orderEditId`, `itemChangeId`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)[]\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderEdit[]", + "type": "[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderEdit", + "type": "[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)[], `number`]\> + +#### Parameters + + & { `q?`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderEdit[]", + "type": "[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### refreshAdjustments + +▸ **refreshAdjustments**(`orderEditId`, `config?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### removeLineItem + +▸ **removeLineItem**(`orderEditId`, `lineItemId`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### requestConfirmation + +▸ **requestConfirmation**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderEdit", + "type": "[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`orderEditId`, `config?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderEdit", + "type": "[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveActive + +▸ `Protected` **retrieveActive**(`orderId`, `config?`): `Promise`<`undefined` \| ``null`` \| [`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`undefined` \| ``null`` \| [`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "undefined \\| ``null`` \\| OrderEdit", + "type": "`undefined` \\| ``null`` \\| [`OrderEdit`](admin_collections.internal.OrderEdit.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`orderEditId`, `data`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "OrderEdit", + "type": "[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`OrderEditService`](admin_discounts.internal.internal.OrderEditService.mdx) + +#### Parameters + + + +#### Returns + +[`OrderEditService`](admin_discounts.internal.internal.OrderEditService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderService.mdx new file mode 100644 index 0000000000..4e26b1efe0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderService.mdx @@ -0,0 +1,2186 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).OrderService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "addressRepository_", + "type": "`Repository`<[`Address`](admin_collections.internal.Address.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cartService_", + "type": "[`CartService`](admin_discounts.internal.internal.CartService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customerService_", + "type": "[`CustomerService`](admin_discounts.internal.internal.CustomerService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountService_", + "type": "[`DiscountService`](admin_discounts.internal.internal.DiscountService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draftOrderService_", + "type": "[`DraftOrderService`](admin_discounts.internal.internal.DraftOrderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillmentProviderService_", + "type": "[`FulfillmentProviderService`](admin_discounts.internal.internal.FulfillmentProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillmentService_", + "type": "[`FulfillmentService`](admin_discounts.internal.FulfillmentService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "getTotalsRelations", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "giftCardService_", + "type": "[`GiftCardService`](admin_discounts.internal.internal.GiftCardService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventoryService_", + "type": "[`IInventoryService`](../interfaces/admin_discounts.internal.IInventoryService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemService_", + "type": "[`LineItemService`](admin_discounts.internal.internal.LineItemService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "newTotalsService_", + "type": "[`NewTotalsService`](admin_discounts.internal.internal.NewTotalsService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orderRepository_", + "type": "`Repository`<[`Order`](admin_collections.internal.Order.mdx)\\> & { `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentProviderService_", + "type": "[`PaymentProviderService`](admin_discounts.internal.internal.PaymentProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantInventoryService_", + "type": "[`ProductVariantInventoryService`](admin_discounts.internal.internal.ProductVariantInventoryService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regionService_", + "type": "[`RegionService`](admin_discounts.internal.internal.RegionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingOptionService_", + "type": "[`ShippingOptionService`](admin_discounts.internal.internal.ShippingOptionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingProfileService_", + "type": "[`ShippingProfileService`](admin_discounts.internal.internal.ShippingProfileService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxProviderService_", + "type": "[`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "totalsService_", + "type": "[`TotalsService`](admin_discounts.internal.internal.TotalsService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CANCELED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.COMPLETED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.FULFILLMENT_CANCELED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.FULFILLMENT_CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.GIFT_CARD_CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.ITEMS_RETURNED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PAYMENT_CAPTURED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PAYMENT_CAPTURE_FAILED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PLACED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.REFUND_CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.REFUND_FAILED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.RETURN_ACTION_REQUIRED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.RETURN_REQUESTED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.SHIPMENT_CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.SWAP_CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addShippingMethod + +▸ **addShippingMethod**(`orderId`, `optionId`, `data?`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`CreateShippingMethodDto`](../../admin_discounts/modules/admin_discounts.internal.mdx#createshippingmethoddto)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### archive + +▸ **archive**(`orderId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +Archives an order. It only alloved, if the order has been fulfilled +and payment has been captured. + +#### Parameters + + + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### cancel + +▸ **cancel**(`orderId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +Cancels an order. +Throws if fulfillment process has been initiated. +Throws if payment process has been initiated. + +#### Parameters + + + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "result of the update operation.", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +Cancels a fulfillment (if related to an order) + +#### Parameters + + + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated order", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### capturePayment + +▸ **capturePayment**(`orderId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +Captures payment for an order. + +#### Parameters + + + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "result of the update operation.", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### completeOrder + +▸ **completeOrder**(`orderId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createFromCart + +▸ **createFromCart**(`cartOrId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +Creates an order from a cart + +#### Parameters + + + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the creation result.", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createFulfillment + +▸ **createFulfillment**(`orderId`, `itemsToFulfill`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +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 + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config.no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "result of the update operation.", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createGiftCardsFromLineItem\_ + +▸ `Protected` **createGiftCardsFromLineItem_**(`order`, `lineItem`, `manager`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\>[] + +#### Parameters + + + +#### Returns + +`Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\>[] + +[]", + "type": "`Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\\>[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Promise", + "type": "`Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "GiftCard", + "type": "[`GiftCard`](admin_collections.internal.GiftCard.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### createRefund + +▸ **createRefund**(`orderId`, `refundAmount`, `reason`, `note?`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +Refunds a given amount back to the customer. + +#### Parameters + + + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the refund operation.", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createShipment + +▸ **createShipment**(`orderId`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +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 + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config.no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the resulting order following the update.", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### decorateTotals + +▸ **decorateTotals**(`order`, `totalsFields?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +▸ **decorateTotals**(`order`, `context?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### decorateTotalsLegacy + +▸ `Protected` **decorateTotalsLegacy**(`order`, `totalsFields?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getFulfillmentItems + +▸ `Protected` **getFulfillmentItems**(`order`, `items`, `transformer`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> + +Retrieves the order line items, given an array of items. + +#### Parameters + + `unknown`", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the line items generated by the transformer.", + "children": [ + { + "name": "LineItem[]", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "LineItem", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)[]\> + +#### Parameters + +", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Order`](admin_collections.internal.Order.mdx)\\>", + "description": "the config to be used for find", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "Order[]", + "type": "[`Order`](admin_collections.internal.Order.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Order`](admin_collections.internal.Order.mdx)[], `number`]\> + +#### Parameters + +", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Order`](admin_collections.internal.Order.mdx)\\>", + "description": "the config to be used for find", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`Order`](admin_collections.internal.Order.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "Order[]", + "type": "[`Order`](admin_collections.internal.Order.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### registerReturnReceived + +▸ **registerReturnReceived**(`orderId`, `receivedReturn`, `customRefundAmount?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`orderId`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +Gets an order by id. + +#### Parameters + +", + "description": "config of order to retrieve", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the order document", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByCartId + +▸ **retrieveByCartId**(`cartId`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +Gets an order by cart id. + +#### Parameters + +", + "description": "the config to be used to find order", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the order document", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByCartIdWithTotals + +▸ **retrieveByCartIdWithTotals**(`cartId`, `options?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByExternalId + +▸ **retrieveByExternalId**(`externalId`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +Gets an order by id. + +#### Parameters + +", + "description": "query config to get order by", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the order document", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveLegacy + +▸ `Protected` **retrieveLegacy**(`orderIdOrSelector`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Order`](admin_collections.internal.Order.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveWithTotals + +▸ **retrieveWithTotals**(`orderId`, `options?`, `context?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`TotalsContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#totalscontext)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### transformQueryForTotals + +▸ `Protected` **transformQueryForTotals**(`config`): { `relations`: `undefined` \| `string`[] ; `select`: `undefined` \| keyof [`Order`](admin_collections.internal.Order.mdx)[] ; `totalsToSelect`: `undefined` \| keyof [`Order`](admin_collections.internal.Order.mdx)[] } + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`object` + + + + + +___ + +### update + +▸ **update**(`orderId`, `update`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +Updates an order. Metadata updates should +use dedicated method, e.g. `setMetadata` etc. The function +will throw errors if metadata updates are attempted. + +#### Parameters + + + +#### Returns + +`Promise`<[`Order`](admin_collections.internal.Order.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the update result.", + "children": [ + { + "name": "Order", + "type": "[`Order`](admin_collections.internal.Order.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateBillingAddress + +▸ `Protected` **updateBillingAddress**(`order`, `address`): `Promise`<`void`\> + +Updates the order's billing address. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [] + } +]} /> + +___ + +### updateShippingAddress + +▸ `Protected` **updateShippingAddress**(`order`, `address`): `Promise`<`void`\> + +Updates the order's shipping address. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [] + } +]} /> + +___ + +### validateFulfillmentLineItem + +▸ `Protected` **validateFulfillmentLineItem**(`item`, `quantity`): ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx) + +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 + + + +#### Returns + +``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx) + + + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`OrderService`](admin_discounts.internal.internal.OrderService.mdx) + +#### Parameters + + + +#### Returns + +[`OrderService`](admin_discounts.internal.internal.OrderService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentCollectionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentCollectionService.mdx new file mode 100644 index 0000000000..c310583350 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentCollectionService.mdx @@ -0,0 +1,797 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentCollectionService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).PaymentCollectionService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "customerService_", + "type": "[`CustomerService`](admin_discounts.internal.internal.CustomerService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBusService_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isValidTotalAmount", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentCollectionRepository_", + "type": "`Repository`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\\> & { `getPaymentCollectionIdByPaymentId`: Method getPaymentCollectionIdByPaymentId ; `getPaymentCollectionIdBySessionId`: Method getPaymentCollectionIdBySessionId }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentProviderService_", + "type": "[`PaymentProviderService`](admin_discounts.internal.internal.PaymentProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.DELETED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PAYMENT_AUTHORIZED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### authorizePaymentSessions + +▸ **authorizePaymentSessions**(`paymentCollectionId`, `sessionIds`, `context?`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +Authorizes the payment sessions of a payment collection. + +#### Parameters + +", + "description": "additional data required by payment providers", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment collection and its payment session.", + "children": [ + { + "name": "PaymentCollection", + "type": "[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`data`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +Creates a new payment collection. + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment collection created.", + "children": [ + { + "name": "PaymentCollection", + "type": "[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`paymentCollectionId`): `Promise`<`undefined` \| [`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +Deletes a payment collection. + +#### Parameters + + + +#### Returns + +`Promise`<`undefined` \| [`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment collection removed.", + "children": [ + { + "name": "undefined \\| PaymentCollection", + "type": "`undefined` \\| [`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### markAsAuthorized + +▸ **markAsAuthorized**(`paymentCollectionId`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +Marks a payment collection as authorized bypassing the payment flow. + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment session authorized.", + "children": [ + { + "name": "PaymentCollection", + "type": "[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### refreshPaymentSession + +▸ **refreshPaymentSession**(`paymentCollectionId`, `sessionId`, `customerId`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +Removes and recreate a payment session of a payment collection. + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the new payment session created.", + "children": [ + { + "name": "PaymentSession", + "type": "[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`paymentCollectionId`, `config?`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +Retrieves a payment collection by id. + +#### Parameters + +", + "description": "the config to retrieve the payment collection", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment collection.", + "children": [ + { + "name": "PaymentCollection", + "type": "[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### setPaymentSession + +▸ **setPaymentSession**(`paymentCollectionId`, `sessionInput`, `customerId`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +Manages a single payment sessions of a payment collection. + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment collection and its payment session.", + "children": [ + { + "name": "PaymentCollection", + "type": "[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### setPaymentSessionsBatch + +▸ **setPaymentSessionsBatch**(`paymentCollectionOrId`, `sessionsInput`, `customerId`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +Manages multiple payment sessions of a payment collection. + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment collection and its payment sessions.", + "children": [ + { + "name": "PaymentCollection", + "type": "[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`paymentCollectionId`, `data`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +Updates a payment collection. + +#### Parameters + +", + "description": "info to be updated", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment collection updated.", + "children": [ + { + "name": "PaymentCollection", + "type": "[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PaymentCollectionService`](admin_discounts.internal.internal.PaymentCollectionService.mdx) + +#### Parameters + + + +#### Returns + +[`PaymentCollectionService`](admin_discounts.internal.internal.PaymentCollectionService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentProviderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentProviderService.mdx new file mode 100644 index 0000000000..dc35e71059 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentProviderService.mdx @@ -0,0 +1,1654 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentProviderService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).PaymentProviderService + +Helps retrieve payment providers + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "container_", + "type": "[`InjectedDependencies`](../../admin_discounts/modules/admin_discounts.internal.mdx#injecteddependencies-22)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customerService_", + "type": "[`CustomerService`](admin_discounts.internal.internal.CustomerService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "logger_", + "type": "[`Logger`](../modules/admin_discounts.internal.internal.mdx#logger)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentProviderRepository_", + "type": "`Repository`<[`PaymentProvider`](admin_collections.internal.PaymentProvider.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentRepository_", + "type": "`Repository`<[`Payment`](admin_collections.internal.Payment.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentSessionRepository_", + "type": "`Repository`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundRepository_", + "type": "`Repository`<[`Refund`](admin_collections.internal.Refund.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "throwFromPaymentProcessorError", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +___ + +### paymentService\_ + +• `Protected` `get` **paymentService_**(): [`PaymentService`](admin_discounts.internal.PaymentService.mdx) + +#### Returns + +[`PaymentService`](admin_discounts.internal.PaymentService.mdx) + + + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### authorizePayment + +▸ **authorizePayment**(`paymentSession`, `context`): `Promise`<`undefined` \| [`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`undefined` \| [`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "undefined \\| PaymentSession", + "type": "`undefined` \\| [`PaymentSession`](admin_collections.internal.PaymentSession.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### buildPaymentProcessorContext + +▸ `Protected` **buildPaymentProcessorContext**(`cartOrData`): [`Cart`](admin_collections.internal.Cart.mdx) & [`PaymentContext`](../modules/admin_discounts.internal.internal.mdx#paymentcontext) + +Build the create session context for both legacy and new API + +#### Parameters + + + +#### Returns + +[`Cart`](admin_collections.internal.Cart.mdx) & [`PaymentContext`](../modules/admin_discounts.internal.internal.mdx#paymentcontext) + + + +___ + +### cancelPayment + +▸ **cancelPayment**(`paymentObj`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +#### Parameters + + & { `id`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Payment", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### capturePayment + +▸ **capturePayment**(`paymentObj`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +#### Parameters + + & { `id`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Payment", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createPayment + +▸ **createPayment**(`data`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Payment", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createSession + +▸ **createSession**(`providerId`, `cart`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PaymentSession", + "type": "[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +▸ **createSession**(`sessionInput`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +Creates a payment session with the given provider. + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PaymentSession", + "type": "[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteSession + +▸ **deleteSession**(`paymentSession`): `Promise`<`undefined` \| [`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<`undefined` \| [`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "undefined \\| PaymentSession", + "type": "`undefined` \\| [`PaymentSession`](admin_collections.internal.PaymentSession.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getStatus + +▸ **getStatus**(`payment`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AUTHORIZED", + "type": "``\"authorized\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "ERROR", + "type": "``\"error\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_MORE", + "type": "``\"requires_more\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(): `Promise`<[`PaymentProvider`](admin_collections.internal.PaymentProvider.mdx)[]\> + +#### Returns + +`Promise`<[`PaymentProvider`](admin_collections.internal.PaymentProvider.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PaymentProvider[]", + "type": "[`PaymentProvider`](admin_collections.internal.PaymentProvider.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PaymentProvider", + "type": "[`PaymentProvider`](admin_collections.internal.PaymentProvider.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listPayments + +▸ **listPayments**(`selector`, `config?`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)[]\> + +List all the payments according to the given selector and config. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Payment`](admin_collections.internal.Payment.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Payment`](admin_collections.internal.Payment.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Payment[]", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Payment", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### 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 + + \\| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### refreshSession + +▸ **refreshSession**(`paymentSession`, `sessionInput`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +Refreshes a payment session with the given provider. +This means, that we delete the current one and create a new. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentSession.id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentSession.provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sessionInput", + "type": "[`PaymentSessionInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#paymentsessioninput)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment session", + "children": [ + { + "name": "PaymentSession", + "type": "[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### refundFromPayment + +▸ **refundFromPayment**(`payment`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Refund", + "type": "[`Refund`](admin_collections.internal.Refund.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### refundPayment + +▸ **refundPayment**(`payObjs`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Refund", + "type": "[`Refund`](admin_collections.internal.Refund.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### registerInstalledProviders + +▸ **registerInstalledProviders**(`providerIds`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### retrievePayment + +▸ **retrievePayment**(`paymentId`, `relations?`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +Retrieve a payment entity with the given id. + +#### Parameters + + + +#### Returns + +`Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Payment", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveProvider + +▸ **retrieveProvider**<`TProvider`\>(`providerId`): `TProvider` extends [`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx) ? [`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx) : `TProvider` extends [`AbstractPaymentProcessor`](admin_discounts.internal.internal.AbstractPaymentProcessor.mdx) ? [`AbstractPaymentProcessor`](admin_discounts.internal.internal.AbstractPaymentProcessor.mdx) : `any` + +Finds a provider given an id + + + +#### Parameters + + + +#### Returns + +`TProvider` extends [`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx) ? [`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx) : `TProvider` extends [`AbstractPaymentProcessor`](admin_discounts.internal.internal.AbstractPaymentProcessor.mdx) ? [`AbstractPaymentProcessor`](admin_discounts.internal.internal.AbstractPaymentProcessor.mdx) : `any` + + + +___ + +### retrieveRefund + +▸ **retrieveRefund**(`id`, `config?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Refund", + "type": "[`Refund`](admin_collections.internal.Refund.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveSession + +▸ **retrieveSession**(`paymentSessionId`, `relations?`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +Return the payment session for the given id. + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PaymentSession", + "type": "[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### saveSession + +▸ `Protected` **saveSession**(`providerId`, `data`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +Create or update a Payment session data. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data.status", + "type": "[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PaymentSession", + "type": "[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### updatePayment + +▸ **updatePayment**(`paymentId`, `data`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Payment", + "type": "[`Payment`](admin_collections.internal.Payment.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateSession + +▸ **updateSession**(`paymentSession`, `sessionInput`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +Update a payment session with the given provider. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentSession.id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentSession.provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sessionInput", + "type": "[`Cart`](admin_collections.internal.Cart.mdx) \\| [`PaymentSessionInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#paymentsessioninput)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the payment session", + "children": [ + { + "name": "PaymentSession", + "type": "[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateSessionData + +▸ **updateSessionData**(`paymentSession`, `data`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PaymentSession", + "type": "[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PaymentProviderService`](admin_discounts.internal.internal.PaymentProviderService.mdx) + +#### Parameters + + + +#### Returns + +[`PaymentProviderService`](admin_discounts.internal.internal.PaymentProviderService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PriceListService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PriceListService.mdx new file mode 100644 index 0000000000..024265e01f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PriceListService.mdx @@ -0,0 +1,1159 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).PriceListService + +Provides layer to manipulate product tags. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "customerGroupService_", + "type": "[`CustomerGroupService`](admin_discounts.internal.internal.CustomerGroupService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "moneyAmountRepo_", + "type": "`Repository`<[`MoneyAmount`](admin_collections.internal.MoneyAmount.mdx)\\> & { `addPriceListPrices`: Method addPriceListPrices ; `createProductVariantMoneyAmounts`: Method createProductVariantMoneyAmounts ; `deletePriceListPrices`: Method deletePriceListPrices ; `deleteVariantPricesNotIn`: Method deleteVariantPricesNotIn ; `findCurrencyMoneyAmounts`: Method findCurrencyMoneyAmounts ; `findManyForVariantInPriceList`: Method findManyForVariantInPriceList ; `findManyForVariantInRegion`: Method findManyForVariantInRegion ; `findManyForVariantsInRegion`: Method findManyForVariantsInRegion ; `findRegionMoneyAmounts`: Method findRegionMoneyAmounts ; `findVariantPricesNotIn`: Method findVariantPricesNotIn ; `getPricesForVariantInRegion`: Method getPricesForVariantInRegion ; `insertBulk`: Method insertBulk ; `updatePriceListPrices`: Method updatePriceListPrices ; `upsertVariantCurrencyPrice`: Method upsertVariantCurrencyPrice }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "priceListRepo_", + "type": "`Repository`<[`PriceList`](admin_collections.internal.PriceList.mdx)\\> & { `listAndCount`: Method listAndCount ; `listPriceListsVariantIdsMap`: Method listPriceListsVariantIdsMap }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productService_", + "type": "[`ProductService`](admin_discounts.internal.internal.ProductService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantRepo_", + "type": "`Repository`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regionService_", + "type": "[`RegionService`](admin_discounts.internal.internal.RegionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variantService_", + "type": "[`ProductVariantService`](admin_discounts.internal.internal.ProductVariantService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addCurrencyFromRegion + +▸ `Protected` **addCurrencyFromRegion**<`T`\>(`prices`): `Promise`<`T`[]\> + +Add `currency_code` to an MA record if `region_id`is passed. + + + +#### Parameters + + + +#### Returns + +`Promise`<`T`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "updated `prices` list", + "children": [ + { + "name": "T[]", + "type": "`T`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### addPrices + +▸ **addPrices**(`id`, `prices`, `replace?`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> + +Adds prices to a price list in bulk, optionally replacing all existing prices + +#### Parameters + + + +#### Returns + +`Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated Price List", + "children": [ + { + "name": "PriceList", + "type": "[`PriceList`](admin_collections.internal.PriceList.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### clearPrices + +▸ **clearPrices**(`id`): `Promise`<`void`\> + +Removes all prices from a price list and deletes the removed prices in bulk + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "updated Price List", + "children": [] + } +]} /> + +___ + +### create + +▸ **create**(`priceListObject`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> + +Creates a Price List + +#### Parameters + + + +#### Returns + +`Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "created Price List", + "children": [ + { + "name": "PriceList", + "type": "[`PriceList`](admin_collections.internal.PriceList.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`id`): `Promise`<`void`\> + +Deletes a Price List +Will never fail due to delete being idempotent. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "empty promise", + "children": [] + } +]} /> + +___ + +### deletePrices + +▸ **deletePrices**(`id`, `priceIds`): `Promise`<`void`\> + +Removes prices from a price list and deletes the removed prices in bulk + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "updated Price List", + "children": [] + } +]} /> + +___ + +### deleteProductPrices + +▸ **deleteProductPrices**(`priceListId`, `productIds`): `Promise`<[`string`[], `number`]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`string`[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string[]", + "type": "`string`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteVariantPrices + +▸ **deleteVariantPrices**(`priceListId`, `variantIds`): `Promise`<[`string`[], `number`]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`string`[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string[]", + "type": "`string`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)[]\> + +Lists Price Lists + +#### Parameters + +", + "description": "the config to be used for find", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "PriceList[]", + "type": "[`PriceList`](admin_collections.internal.PriceList.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PriceList", + "type": "[`PriceList`](admin_collections.internal.PriceList.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`PriceList`](admin_collections.internal.PriceList.mdx)[], `number`]\> + +Lists Price Lists and adds count + +#### Parameters + +", + "description": "the config to be used for find", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`PriceList`](admin_collections.internal.PriceList.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "PriceList[]", + "type": "[`PriceList`](admin_collections.internal.PriceList.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### listPriceListsVariantIdsMap + +▸ **listPriceListsVariantIdsMap**(`priceListIds`): `Promise`<{ `[priceListId: string]`: `string`[]; }\> + +#### Parameters + + + +#### Returns + +`Promise`<{ `[priceListId: string]`: `string`[]; }\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "`object`", + "type": "`object`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### listProducts + +▸ **listProducts**(`priceListId`, `selector?`, `config?`, `requiresPriceList?`): `Promise`<[[`Product`](admin_collections.internal.Product.mdx)[], `number`]\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Product`](admin_collections.internal.Product.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requiresPriceList", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`Product`](admin_collections.internal.Product.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Product[]", + "type": "[`Product`](admin_collections.internal.Product.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### listVariants + +▸ **listVariants**(`priceListId`, `selector?`, `config?`, `requiresPriceList?`): `Promise`<[[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[], `number`]\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requiresPriceList", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariant[]", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`priceListId`, `config?`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> + +Retrieves a product tag by id. + +#### Parameters + +", + "description": "the config to retrieve the tag by", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the collection.", + "children": [ + { + "name": "PriceList", + "type": "[`PriceList`](admin_collections.internal.PriceList.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`id`, `update`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> + +Updates a Price List + +#### Parameters + + + +#### Returns + +`Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated Price List", + "children": [ + { + "name": "PriceList", + "type": "[`PriceList`](admin_collections.internal.PriceList.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### upsertCustomerGroups\_ + +▸ `Protected` **upsertCustomerGroups_**(`priceListId`, `customerGroups`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PriceListService`](admin_discounts.internal.internal.PriceListService.mdx) + +#### Parameters + + + +#### Returns + +[`PriceListService`](admin_discounts.internal.internal.PriceListService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PricingService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PricingService.mdx new file mode 100644 index 0000000000..bf95a371a0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PricingService.mdx @@ -0,0 +1,923 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PricingService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).PricingService + +Allows retrieval of prices. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "getProductPricing_", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "getProductVariantPricing_", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "priceSelectionStrategy", + "type": "[`IPriceSelectionStrategy`](../interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantService", + "type": "[`ProductVariantService`](admin_discounts.internal.internal.ProductVariantService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regionService", + "type": "[`RegionService`](admin_discounts.internal.internal.RegionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxProviderService", + "type": "[`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### calculateTaxes + +▸ **calculateTaxes**(`variantPricing`, `productRates`): [`TaxedPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxedpricing) + +Gets the prices for a product variant + +#### Parameters + + + +#### Returns + +[`TaxedPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxedpricing) + + + +___ + +### collectPricingContext + +▸ **collectPricingContext**(`context`): `Promise`<[`PricingContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricingcontext)\> + +Collects additional information necessary for completing the price +selection. + +#### Parameters + + + +#### Returns + +`Promise`<[`PricingContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricingcontext)\> + +", + "optional": false, + "defaultValue": "", + "description": "The pricing context", + "children": [ + { + "name": "PricingContext", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### getProductPricing + +▸ **getProductPricing**(`product`, `context`): `Promise`\> + +Gets all the variant prices for a product. All the product's variants will +be fetched. + +#### Parameters + +", + "description": "the product to get pricing for.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`PriceSelectionContext`](../modules/admin_discounts.internal.internal.mdx#priceselectioncontext)", + "description": "the price selection context to use", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "A map of variant ids to their corresponding prices", + "children": [ + { + "name": "Record", + "type": "Record<`string`, [`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "ProductVariantPricing", + "type": "{ `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`](admin_collections.internal.MoneyAmount.mdx)[] } & [`TaxedPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxedpricing)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### getProductPricingById + +▸ **getProductPricingById**(`productId`, `context`): `Promise`\> + +Gets all the variant prices for a product by the product id + +#### Parameters + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "A map of variant ids to their corresponding prices", + "children": [ + { + "name": "Record", + "type": "Record<`string`, [`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "ProductVariantPricing", + "type": "{ `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`](admin_collections.internal.MoneyAmount.mdx)[] } & [`TaxedPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxedpricing)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### getProductVariantPricing + +▸ **getProductVariantPricing**(`variant`, `context`): `Promise`<[`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing)\> + +Gets the prices for a product variant. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`PriceSelectionContext`](../modules/admin_discounts.internal.internal.mdx#priceselectioncontext) \\| [`PricingContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricingcontext)", + "description": "the price selection context to use", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing)\> + +", + "optional": false, + "defaultValue": "", + "description": "The product variant prices", + "children": [ + { + "name": "ProductVariantPricing", + "type": "{ `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`](admin_collections.internal.MoneyAmount.mdx)[] } & [`TaxedPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxedpricing)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### getProductVariantPricingById + +▸ **getProductVariantPricingById**(`variantId`, `context`): `Promise`<[`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing)\> + +Gets the prices for a product variant by a variant id. + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing)\> + +", + "optional": false, + "defaultValue": "", + "description": "The product variant prices", + "children": [ + { + "name": "ProductVariantPricing", + "type": "{ `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`](admin_collections.internal.MoneyAmount.mdx)[] } & [`TaxedPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxedpricing)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +Use [getProductVariantsPricing](admin_discounts.internal.internal.PricingService.mdx#getproductvariantspricing) instead. + +___ + +### getProductVariantsPricing + +▸ **getProductVariantsPricing**(`data`, `context`): `Promise`<{ `[variant_id: string]`: [`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing); }\> + +Gets the prices for a collection of variants. + +#### Parameters + + + +#### Returns + +`Promise`<{ `[variant_id: string]`: [`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing); }\> + +", + "optional": false, + "defaultValue": "", + "description": "The product variant prices", + "children": [ + { + "name": "`object`", + "type": "`object`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getShippingOptionPricing + +▸ **getShippingOptionPricing**(`shippingOption`, `context`): `Promise`<[`PricedShippingOption`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedshippingoption)\> + +Gets the prices for a shipping option. + +#### Parameters + + + +#### Returns + +`Promise`<[`PricedShippingOption`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedshippingoption)\> + +", + "optional": false, + "defaultValue": "", + "description": "The shipping option prices", + "children": [ + { + "name": "PricedShippingOption", + "type": "[`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\\> & [`ShippingOptionPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingoptionpricing)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### setProductPrices + +▸ **setProductPrices**(`products`, `context?`): `Promise`<([`Product`](admin_collections.internal.Product.mdx) \| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]\> + +Set additional prices on a list of products. + +#### Parameters + + + +#### Returns + +`Promise`<([`Product`](admin_collections.internal.Product.mdx) \| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]\> + +", + "optional": false, + "defaultValue": "", + "description": "A list of products with variants decorated with prices", + "children": [ + { + "name": "(Product \\| PricedProduct)[]", + "type": "([`Product`](admin_collections.internal.Product.mdx) \\| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Product \\| PricedProduct", + "type": "[`Product`](admin_collections.internal.Product.mdx) \\| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### setShippingOptionPrices + +▸ **setShippingOptionPrices**(`shippingOptions`, `context?`): `Promise`<[`PricedShippingOption`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedshippingoption)[]\> + +Set additional prices on a list of shipping options. + +#### Parameters + +", + "description": "the price selection context to use", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PricedShippingOption`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedshippingoption)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "A list of shipping options with prices", + "children": [ + { + "name": "PricedShippingOption[]", + "type": "[`PricedShippingOption`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedshippingoption)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PricedShippingOption", + "type": "[`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\\> & [`ShippingOptionPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingoptionpricing)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### setVariantPrices + +▸ **setVariantPrices**(`variants`, `context?`): `Promise`<[`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]\> + +Set additional prices on a list of product variants. + +#### Parameters + + + +#### Returns + +`Promise`<[`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "A list of products with variants decorated with prices", + "children": [ + { + "name": "PricedVariant[]", + "type": "[`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PricedVariant", + "type": "[`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\\> & [`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PricingService`](admin_discounts.internal.internal.PricingService.mdx) + +#### Parameters + + + +#### Returns + +[`PricingService`](admin_discounts.internal.internal.PricingService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCategoryService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCategoryService.mdx new file mode 100644 index 0000000000..ec20aa1003 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCategoryService.mdx @@ -0,0 +1,953 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductCategoryService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ProductCategoryService + +Provides layer to manipulate product categories. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBusService_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryRepo_", + "type": "`TreeRepository`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\\> & { `addProducts`: Method addProducts ; `findOneWithDescendants`: Method findOneWithDescendants ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `removeProducts`: Method removeProducts }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.DELETED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addProducts + +▸ **addProducts**(`productCategoryId`, `productIds`): `Promise`<`void`\> + +Add a batch of product to a product category + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the product category on which the products have been added", + "children": [] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`productCategoryInput`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> + +Creates a product category + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "created product category", + "children": [ + { + "name": "ProductCategory", + "type": "[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`productCategoryId`): `Promise`<`void`\> + +Deletes a product category + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "a promise", + "children": [] + } +]} /> + +___ + +### fetchReorderConditions + +▸ `Protected` **fetchReorderConditions**(`productCategory`, `input`, `shouldDeleteElement?`): [`ReorderConditions`](../../admin_discounts/modules/admin_discounts.internal.mdx#reorderconditions) + +#### Parameters + + + +#### Returns + +[`ReorderConditions`](../../admin_discounts/modules/admin_discounts.internal.mdx#reorderconditions) + + + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`, `treeSelector?`): `Promise`<[[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)[], `number`]\> + +Lists product category based on the provided parameters and includes the count of +product category that match the query. + +#### Parameters + +", + "description": "Filter options for product category.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\\>", + "description": "Configuration for query.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "treeSelector", + "type": "[`QuerySelector`](../modules/admin_discounts.internal.internal.mdx#queryselector)<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\\>", + "description": "Filter options for product category tree relations", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "an array containing the product category as\n the first element and the total count of product category that matches the query\n as the second element.", + "children": [ + { + "name": "ProductCategory[]", + "type": "[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### performReordering + +▸ `Protected` **performReordering**(`repository`, `conditions`): `Promise`<`void`\> + +#### Parameters + + & { `addProducts`: Method addProducts ; `findOneWithDescendants`: Method findOneWithDescendants ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `removeProducts`: Method removeProducts }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "conditions", + "type": "[`ReorderConditions`](../../admin_discounts/modules/admin_discounts.internal.mdx#reorderconditions)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### removeProducts + +▸ **removeProducts**(`productCategoryId`, `productIds`): `Promise`<`void`\> + +Remove a batch of product from a product category + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the product category on which the products have been removed", + "children": [] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`productCategoryId`, `config?`, `selector?`, `treeSelector?`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> + +Retrieves a product category by id. + +#### Parameters + +", + "description": "the config of the product category to retrieve.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "selector", + "type": "[`Selector`](../modules/admin_discounts.internal.internal.mdx#selector)<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "treeSelector", + "type": "[`QuerySelector`](../modules/admin_discounts.internal.internal.mdx#queryselector)<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the product category.", + "children": [ + { + "name": "ProductCategory", + "type": "[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByHandle + +▸ **retrieveByHandle**(`handle`, `config?`, `selector?`, `treeSelector?`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> + +Retrieves a product category by handle. + +#### Parameters + +", + "description": "the config of the product category to retrieve.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "selector", + "type": "[`Selector`](../modules/admin_discounts.internal.internal.mdx#selector)<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "treeSelector", + "type": "[`QuerySelector`](../modules/admin_discounts.internal.internal.mdx#queryselector)<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the product category.", + "children": [ + { + "name": "ProductCategory", + "type": "[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve\_ + +▸ `Protected` **retrieve_**(`config?`, `selector?`, `treeSelector?`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> + +A generic retrieve for fining product categories by different attributes. + +#### Parameters + +", + "description": "the config of the product category to retrieve.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "selector", + "type": "[`Selector`](../modules/admin_discounts.internal.internal.mdx#selector)<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "treeSelector", + "type": "[`QuerySelector`](../modules/admin_discounts.internal.internal.mdx#queryselector)<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the product category.", + "children": [ + { + "name": "ProductCategory", + "type": "[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shiftSiblings + +▸ `Protected` **shiftSiblings**(`repository`, `conditions`): `Promise`<`void`\> + +#### Parameters + + & { `addProducts`: Method addProducts ; `findOneWithDescendants`: Method findOneWithDescendants ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `removeProducts`: Method removeProducts }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "conditions", + "type": "[`ReorderConditions`](../../admin_discounts/modules/admin_discounts.internal.mdx#reorderconditions)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### transformParentIdToEntity + +▸ `Protected` **transformParentIdToEntity**(`productCategoryInput`): `Promise`<[`CreateProductCategoryInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#createproductcategoryinput) \| [`UpdateProductCategoryInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#updateproductcategoryinput)\> + +Accepts an input object and transforms product_category_id +into product_category entity. + +#### Parameters + + + +#### Returns + +`Promise`<[`CreateProductCategoryInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#createproductcategoryinput) \| [`UpdateProductCategoryInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#updateproductcategoryinput)\> + +", + "optional": false, + "defaultValue": "", + "description": "transformed productCategoryInput", + "children": [ + { + "name": "CreateProductCategoryInput \\| UpdateProductCategoryInput", + "type": "[`CreateProductCategoryInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#createproductcategoryinput) \\| [`UpdateProductCategoryInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#updateproductcategoryinput)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`productCategoryId`, `productCategoryInput`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> + +Updates a product category + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated product category", + "children": [ + { + "name": "ProductCategory", + "type": "[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductCategoryService`](admin_discounts.internal.internal.ProductCategoryService.mdx) + +#### Parameters + + + +#### Returns + +[`ProductCategoryService`](admin_discounts.internal.internal.ProductCategoryService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCollectionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCollectionService.mdx new file mode 100644 index 0000000000..bb7e2c2459 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCollectionService.mdx @@ -0,0 +1,778 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductCollectionService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ProductCollectionService + +Provides layer to manipulate product collections. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCollectionRepository_", + "type": "`Repository`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\\> & { `findAndCountByDiscountConditionId`: Method findAndCountByDiscountConditionId }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productRepository_", + "type": "`Repository`<[`Product`](admin_collections.internal.Product.mdx)\\> & { `_applyCategoriesQuery`: Method \\_applyCategoriesQuery ; `_findWithRelations`: Method \\_findWithRelations ; `bulkAddToCollection`: Method bulkAddToCollection ; `bulkRemoveFromCollection`: Method bulkRemoveFromCollection ; `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations ; `findWithRelationsAndCount`: Method findWithRelationsAndCount ; `getCategoryIdsFromInput`: Method getCategoryIdsFromInput ; `getCategoryIdsRecursively`: Method getCategoryIdsRecursively ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `isProductInSalesChannels`: Method isProductInSalesChannels ; `queryProducts`: Method queryProducts ; `queryProductsWithIds`: Method queryProductsWithIds }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.DELETED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PRODUCTS_ADDED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PRODUCTS_REMOVED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addProducts + +▸ **addProducts**(`collectionId`, `productIds`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductCollection", + "type": "[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`collection`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> + +Creates a product collection + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "created collection", + "children": [ + { + "name": "ProductCollection", + "type": "[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`collectionId`): `Promise`<`void`\> + +Deletes a product collection idempotently + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "empty promise", + "children": [] + } +]} /> + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)[]\> + +Lists product collections + +#### Parameters + + & { `discount_condition_id?`: `string` ; `q?`: `string` }", + "description": "the query object for find", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "`object`", + "description": "the config to be used for find", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config.skip", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config.take", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "ProductCollection[]", + "type": "[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductCollection", + "type": "[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)[], `number`]\> + +Lists product collections and add count. + +#### Parameters + +", + "description": "the config to be used for find", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "ProductCollection[]", + "type": "[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeProducts + +▸ **removeProducts**(`collectionId`, `productIds`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`collectionId`, `config?`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> + +Retrieves a product collection by id. + +#### Parameters + +", + "description": "the config of the collection to retrieve.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the collection.", + "children": [ + { + "name": "ProductCollection", + "type": "[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByHandle + +▸ **retrieveByHandle**(`collectionHandle`, `config?`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> + +Retrieves a product collection by id. + +#### Parameters + +", + "description": "query config for request", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the collection.", + "children": [ + { + "name": "ProductCollection", + "type": "[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`collectionId`, `update`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> + +Updates a product collection + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "update collection", + "children": [ + { + "name": "ProductCollection", + "type": "[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductCollectionService`](admin_discounts.internal.internal.ProductCollectionService.mdx) + +#### Parameters + + + +#### Returns + +[`ProductCollectionService`](admin_discounts.internal.internal.ProductCollectionService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductService.mdx new file mode 100644 index 0000000000..d730b1d097 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductService.mdx @@ -0,0 +1,1563 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ProductService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "imageRepository_", + "type": "`Repository`<[`Image`](admin_collections.internal.Image.mdx)\\> & { `insertBulk`: Method insertBulk ; `upsertImages`: Method upsertImages }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryRepository_", + "type": "`TreeRepository`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\\> & { `addProducts`: Method addProducts ; `findOneWithDescendants`: Method findOneWithDescendants ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `removeProducts`: Method removeProducts }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productOptionRepository_", + "type": "`Repository`<[`ProductOption`](admin_collections.internal.ProductOption.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productRepository_", + "type": "`Repository`<[`Product`](admin_collections.internal.Product.mdx)\\> & { `_applyCategoriesQuery`: Method \\_applyCategoriesQuery ; `_findWithRelations`: Method \\_findWithRelations ; `bulkAddToCollection`: Method bulkAddToCollection ; `bulkRemoveFromCollection`: Method bulkRemoveFromCollection ; `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations ; `findWithRelationsAndCount`: Method findWithRelationsAndCount ; `getCategoryIdsFromInput`: Method getCategoryIdsFromInput ; `getCategoryIdsRecursively`: Method getCategoryIdsRecursively ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `isProductInSalesChannels`: Method isProductInSalesChannels ; `queryProducts`: Method queryProducts ; `queryProductsWithIds`: Method queryProductsWithIds }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productTagRepository_", + "type": "`Repository`<[`ProductTag`](admin_collections.internal.ProductTag.mdx)\\> & { `findAndCountByDiscountConditionId`: Method findAndCountByDiscountConditionId ; `insertBulk`: Method insertBulk ; `listTagsByUsage`: Method listTagsByUsage ; `upsertTags`: Method upsertTags }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productTypeRepository_", + "type": "`Repository`<[`ProductType`](admin_collections.internal.ProductType.mdx)\\> & { `findAndCountByDiscountConditionId`: Method findAndCountByDiscountConditionId ; `upsertType`: Method upsertType }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantRepository_", + "type": "`Repository`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantService_", + "type": "[`ProductVariantService`](admin_discounts.internal.internal.ProductVariantService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "searchService_", + "type": "[`SearchService`](admin_discounts.internal.internal.SearchService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.DELETED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "IndexName", + "type": "``\"products\"``", + "description": "", + "optional": false, + "defaultValue": "`\"products\"`", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addOption + +▸ **addOption**(`productId`, `optionTitle`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the model update operation", + "children": [ + { + "name": "Product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### count + +▸ **count**(`selector?`): `Promise`<`number`\> + +Return the total number of documents in database + +#### Parameters + +", + "description": "the selector to choose products by", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the count operation", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`productObject`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +Creates a product. + +#### Parameters + + + +#### Returns + +`Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the creation result.", + "children": [ + { + "name": "Product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`productId`): `Promise`<`void`\> + +Deletes a product from a given product id. The product's associated +variants will also be deleted. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "empty promise", + "children": [] + } +]} /> + +___ + +### deleteOption + +▸ **deleteOption**(`productId`, `optionId`): `Promise`<`void` \| [`Product`](admin_collections.internal.Product.mdx)\> + +Delete an option from a product. + +#### Parameters + + + +#### Returns + +`Promise`<`void` \| [`Product`](admin_collections.internal.Product.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated product", + "children": [ + { + "name": "void \\| Product", + "type": "`void` \\| [`Product`](admin_collections.internal.Product.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### filterProductsBySalesChannel + +▸ **filterProductsBySalesChannel**(`productIds`, `salesChannelId`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Product`](admin_collections.internal.Product.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Product[]", + "type": "[`Product`](admin_collections.internal.Product.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### isProductInSalesChannels + +▸ **isProductInSalesChannels**(`id`, `salesChannelIds`): `Promise`<`boolean`\> + +Check if the product is assigned to at least one of the provided sales channels. + +#### Parameters + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)[]\> + +Lists products based on the provided parameters. + +#### Parameters + + + +#### Returns + +`Promise`<[`Product`](admin_collections.internal.Product.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "Product[]", + "type": "[`Product`](admin_collections.internal.Product.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Product`](admin_collections.internal.Product.mdx)[], `number`]\> + +Lists products based on the provided parameters and includes the count of +products that match the query. + +#### Parameters + + + +#### Returns + +`Promise`<[[`Product`](admin_collections.internal.Product.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "an array containing the products as\n the first element and the total count of products that matches the query\n as the second element.", + "children": [ + { + "name": "Product[]", + "type": "[`Product`](admin_collections.internal.Product.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### listTagsByUsage + +▸ **listTagsByUsage**(`take?`): `Promise`<[`ProductTag`](admin_collections.internal.ProductTag.mdx)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductTag`](admin_collections.internal.ProductTag.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductTag[]", + "type": "[`ProductTag`](admin_collections.internal.ProductTag.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductTag", + "type": "[`ProductTag`](admin_collections.internal.ProductTag.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listTypes + +▸ **listTypes**(): `Promise`<[`ProductType`](admin_collections.internal.ProductType.mdx)[]\> + +#### Returns + +`Promise`<[`ProductType`](admin_collections.internal.ProductType.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductType[]", + "type": "[`ProductType`](admin_collections.internal.ProductType.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductType", + "type": "[`ProductType`](admin_collections.internal.ProductType.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### prepareListQuery\_ + +▸ `Protected` **prepareListQuery_**(`selector`, `config`): { `q`: `string` ; `query`: [`FindWithoutRelationsOptions`](../../admin_discounts/modules/admin_discounts.internal.mdx#findwithoutrelationsoptions-1) ; `relations`: keyof [`Product`](admin_collections.internal.Product.mdx)[] } + +Temporary method to be used in place we need custom query strategy to prevent typeorm bug + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindProductConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#findproductconfig)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`object` + + + + + +___ + +### reorderVariants + +▸ **reorderVariants**(`productId`, `variantOrder`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`productId`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +Gets a product by id. +Throws in case of DB Error and if product was not found. + +#### Parameters + + + +#### Returns + +`Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find one operation.", + "children": [ + { + "name": "Product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByExternalId + +▸ **retrieveByExternalId**(`externalId`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +Gets a product by external id. +Throws in case of DB Error and if product was not found. + +#### Parameters + + + +#### Returns + +`Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find one operation.", + "children": [ + { + "name": "Product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByHandle + +▸ **retrieveByHandle**(`productHandle`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +Gets a product by handle. +Throws in case of DB Error and if product was not found. + +#### Parameters + + + +#### Returns + +`Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find one operation.", + "children": [ + { + "name": "Product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveOptionByTitle + +▸ **retrieveOptionByTitle**(`title`, `productId`): `Promise`<``null`` \| [`ProductOption`](admin_collections.internal.ProductOption.mdx)\> + +Retrieve product's option by title. + +#### Parameters + + + +#### Returns + +`Promise`<``null`` \| [`ProductOption`](admin_collections.internal.ProductOption.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "product option", + "children": [ + { + "name": "``null`` \\| ProductOption", + "type": "``null`` \\| [`ProductOption`](admin_collections.internal.ProductOption.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveVariants + +▸ **retrieveVariants**(`productId`, `config?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> + +Gets all variants belonging to a product. + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "an array of variants", + "children": [ + { + "name": "ProductVariant[]", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariant", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### retrieve\_ + +▸ **retrieve_**(`selector`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +Gets a product by selector. +Throws in case of DB Error and if product was not found. + +#### Parameters + +", + "description": "selector object", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindProductConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#findproductconfig)", + "description": "object that defines what should be included in the query response", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find one operation.", + "children": [ + { + "name": "Product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`productId`, `update`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the update result.", + "children": [ + { + "name": "Product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateOption + +▸ **updateOption**(`productId`, `optionId`, `data`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`Product`](admin_collections.internal.Product.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated product", + "children": [ + { + "name": "Product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateShippingProfile + +▸ **updateShippingProfile**(`productIds`, `profileId`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)[]\> + +Assign a product to a profile, if a profile id null is provided then detach the product from the profile + +#### Parameters + + + +#### Returns + +`Promise`<[`Product`](admin_collections.internal.Product.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "updated products", + "children": [ + { + "name": "Product[]", + "type": "[`Product`](admin_collections.internal.Product.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductService`](admin_discounts.internal.internal.ProductService.mdx) + +#### Parameters + + + +#### Returns + +[`ProductService`](admin_discounts.internal.internal.ProductService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTaxRate.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTaxRate.mdx new file mode 100644 index 0000000000..4c44f4301a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTaxRate.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductTaxRate + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ProductTaxRate + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](admin_collections.internal.Product.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "[`TaxRate`](admin_collections.internal.TaxRate.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTypeService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTypeService.mdx new file mode 100644 index 0000000000..b2d8da33bc --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTypeService.mdx @@ -0,0 +1,417 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductTypeService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ProductTypeService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "typeRepository_", + "type": "`Repository`<[`ProductType`](admin_collections.internal.ProductType.mdx)\\> & { `findAndCountByDiscountConditionId`: Method findAndCountByDiscountConditionId ; `upsertType`: Method upsertType }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`ProductType`](admin_collections.internal.ProductType.mdx)[]\> + +Lists product types + +#### Parameters + + & { `discount_condition_id?`: `string` ; `q?`: `string` }", + "description": "the query object for find", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`ProductType`](admin_collections.internal.ProductType.mdx)\\>", + "description": "the config to be used for find", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductType`](admin_collections.internal.ProductType.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "ProductType[]", + "type": "[`ProductType`](admin_collections.internal.ProductType.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductType", + "type": "[`ProductType`](admin_collections.internal.ProductType.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`ProductType`](admin_collections.internal.ProductType.mdx)[], `number`]\> + +Lists product types and adds count. + +#### Parameters + + & { `discount_condition_id?`: `string` ; `q?`: `string` }", + "description": "the query object for find", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`ProductType`](admin_collections.internal.ProductType.mdx)\\>", + "description": "the config to be used for find", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`ProductType`](admin_collections.internal.ProductType.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "ProductType[]", + "type": "[`ProductType`](admin_collections.internal.ProductType.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`): `Promise`<[`ProductType`](admin_collections.internal.ProductType.mdx)\> + +Gets a product type by id. +Throws in case of DB Error and if product was not found. + +#### Parameters + +", + "description": "object that defines what should be included in the query response", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductType`](admin_collections.internal.ProductType.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find one operation.", + "children": [ + { + "name": "ProductType", + "type": "[`ProductType`](admin_collections.internal.ProductType.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductTypeService`](admin_discounts.internal.internal.ProductTypeService.mdx) + +#### Parameters + + + +#### Returns + +[`ProductTypeService`](admin_discounts.internal.internal.ProductTypeService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTypeTaxRate.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTypeTaxRate.mdx new file mode 100644 index 0000000000..b0595179d8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTypeTaxRate.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductTypeTaxRate + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ProductTypeTaxRate + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_type", + "type": "[`ProductType`](admin_collections.internal.ProductType.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_type_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "[`TaxRate`](admin_collections.internal.TaxRate.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx new file mode 100644 index 0000000000..992b648230 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx @@ -0,0 +1,1240 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantInventoryService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ProductVariantInventoryService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "cacheService_", + "type": "[`ICacheService`](../interfaces/admin_discounts.internal.ICacheService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBusService_", + "type": "[`IEventBusService`](../interfaces/admin_discounts.internal.IEventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "getAvailabilityContext", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventoryService_", + "type": "[`IInventoryService`](../interfaces/admin_discounts.internal.IInventoryService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantService_", + "type": "[`ProductVariantService`](admin_discounts.internal.internal.ProductVariantService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "salesChannelInventoryService_", + "type": "[`SalesChannelInventoryService`](admin_discounts.internal.internal.SalesChannelInventoryService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "salesChannelLocationService_", + "type": "[`SalesChannelLocationService`](admin_discounts.internal.internal.SalesChannelLocationService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "stockLocationService_", + "type": "[`IStockLocationService`](../interfaces/admin_discounts.internal.IStockLocationService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### adjustInventory + +▸ **adjustInventory**(`variantId`, `locationId`, `quantity`): `Promise`<`void`\> + +Adjusts inventory of a variant on a location + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### adjustReservationsQuantityByLineItem + +▸ **adjustReservationsQuantityByLineItem**(`lineItemId`, `variantId`, `locationId`, `quantity`): `Promise`<`void`\> + +Adjusts the quantity of reservations for a line item by a given amount. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### attachInventoryItem + +▸ **attachInventoryItem**(`attachments`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> + +Attach a variant to an inventory item + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the variant inventory item", + "children": [ + { + "name": "ProductVariantInventoryItem[]", + "type": "[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariantInventoryItem", + "type": "[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +▸ **attachInventoryItem**(`variantId`, `inventoryItemId`, `requiredQuantity?`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariantInventoryItem[]", + "type": "[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariantInventoryItem", + "type": "[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### confirmInventory + +▸ **confirmInventory**(`variantId`, `quantity`, `context?`): `Promise`<[`Boolean`](../../admin_collections/modules/admin_collections.internal.mdx#boolean)\> + +confirms if requested inventory is available + +#### Parameters + + + +#### Returns + +`Promise`<[`Boolean`](../../admin_collections/modules/admin_collections.internal.mdx#boolean)\> + +", + "optional": false, + "defaultValue": "", + "description": "boolean indicating if inventory is available", + "children": [ + { + "name": "Boolean", + "type": "(`value?`: `T`) => `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteReservationsByLineItem + +▸ **deleteReservationsByLineItem**(`lineItemId`, `variantId`, `quantity`): `Promise`<`void`\> + +delete a reservation of variant quantity + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### detachInventoryItem + +▸ **detachInventoryItem**(`inventoryItemId`, `variantId?`): `Promise`<`void`\> + +Remove a variant from an inventory item + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "The available quantity of the variant from the inventoryItems", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### listByItem + +▸ **listByItem**(`itemIds`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> + +list registered inventory items + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "list of inventory items", + "children": [ + { + "name": "ProductVariantInventoryItem[]", + "type": "[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariantInventoryItem", + "type": "[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listByVariant + +▸ **listByVariant**(`variantId`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> + +List inventory items for a specific variant + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "variant inventory items for the variant id", + "children": [ + { + "name": "ProductVariantInventoryItem[]", + "type": "[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariantInventoryItem", + "type": "[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listInventoryItemsByVariant + +▸ **listInventoryItemsByVariant**(`variantId`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[]\> + +lists inventory items for a given variant + +#### Parameters + + + +#### Returns + +`Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "lidt of inventory items for the variant", + "children": [ + { + "name": "InventoryItemDTO[]", + "type": "[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryItemDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listVariantsByItem + +▸ **listVariantsByItem**(`itemId`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> + +lists variant by inventory item id + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "a list of product variants that are associated with the item id", + "children": [ + { + "name": "ProductVariant[]", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariant", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### reserveQuantity + +▸ **reserveQuantity**(`variantId`, `quantity`, `context?`): `Promise`<`void` \| [`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[]\> + +Reserves a quantity of a variant + +#### Parameters + + + +#### Returns + +`Promise`<`void` \| [`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "void \\| ReservationItemDTO[]", + "type": "`void` \\| [`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[]", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`inventoryItemId`, `variantId`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)\> + +Retrieves a product variant inventory item by its inventory item ID and variant ID. + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "A promise that resolves with the product variant inventory item.", + "children": [ + { + "name": "ProductVariantInventoryItem", + "type": "[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### setProductAvailability + +▸ **setProductAvailability**(`products`, `salesChannelId`): `Promise`<([`Product`](admin_collections.internal.Product.mdx) \| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]\> + +#### Parameters + + + +#### Returns + +`Promise`<([`Product`](admin_collections.internal.Product.mdx) \| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "(Product \\| PricedProduct)[]", + "type": "([`Product`](admin_collections.internal.Product.mdx) \\| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Product \\| PricedProduct", + "type": "[`Product`](admin_collections.internal.Product.mdx) \\| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### setVariantAvailability + +▸ **setVariantAvailability**(`variants`, `salesChannelId`, `availabilityContext?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[] \| [`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[] \| [`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariant[] \\| PricedVariant[]", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[] \\| [`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### validateInventoryAtLocation + +▸ **validateInventoryAtLocation**(`items`, `locationId`): `Promise`<`void`\> + +Validate stock at a location for fulfillment items + +#### Parameters + +[]", + "description": "Fulfillment Line items to validate quantities for", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locationId", + "type": "`string`", + "description": "Location to validate stock at", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "nothing if successful, throws error if not", + "children": [] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductVariantInventoryService`](admin_discounts.internal.internal.ProductVariantInventoryService.mdx) + +#### Parameters + + + +#### Returns + +[`ProductVariantInventoryService`](admin_discounts.internal.internal.ProductVariantInventoryService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantMoneyAmount.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantMoneyAmount.mdx new file mode 100644 index 0000000000..2f94b9de17 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantMoneyAmount.mdx @@ -0,0 +1,72 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantMoneyAmount + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ProductVariantMoneyAmount + +Base abstract entity for all entities + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantService.mdx new file mode 100644 index 0000000000..90739de0ee --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantService.mdx @@ -0,0 +1,1534 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ProductVariantService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "cartRepository_", + "type": "`Repository`<[`Cart`](admin_collections.internal.Cart.mdx)\\> & { `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "moneyAmountRepository_", + "type": "`Repository`<[`MoneyAmount`](admin_collections.internal.MoneyAmount.mdx)\\> & { `addPriceListPrices`: Method addPriceListPrices ; `createProductVariantMoneyAmounts`: Method createProductVariantMoneyAmounts ; `deletePriceListPrices`: Method deletePriceListPrices ; `deleteVariantPricesNotIn`: Method deleteVariantPricesNotIn ; `findCurrencyMoneyAmounts`: Method findCurrencyMoneyAmounts ; `findManyForVariantInPriceList`: Method findManyForVariantInPriceList ; `findManyForVariantInRegion`: Method findManyForVariantInRegion ; `findManyForVariantsInRegion`: Method findManyForVariantsInRegion ; `findRegionMoneyAmounts`: Method findRegionMoneyAmounts ; `findVariantPricesNotIn`: Method findVariantPricesNotIn ; `getPricesForVariantInRegion`: Method getPricesForVariantInRegion ; `insertBulk`: Method insertBulk ; `updatePriceListPrices`: Method updatePriceListPrices ; `upsertVariantCurrencyPrice`: Method upsertVariantCurrencyPrice }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "priceSelectionStrategy_", + "type": "[`IPriceSelectionStrategy`](../interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productOptionValueRepository_", + "type": "`Repository`<[`ProductOptionValue`](admin_collections.internal.ProductOptionValue.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productRepository_", + "type": "`Repository`<[`Product`](admin_collections.internal.Product.mdx)\\> & { `_applyCategoriesQuery`: Method \\_applyCategoriesQuery ; `_findWithRelations`: Method \\_findWithRelations ; `bulkAddToCollection`: Method bulkAddToCollection ; `bulkRemoveFromCollection`: Method bulkRemoveFromCollection ; `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations ; `findWithRelationsAndCount`: Method findWithRelationsAndCount ; `getCategoryIdsFromInput`: Method getCategoryIdsFromInput ; `getCategoryIdsRecursively`: Method getCategoryIdsRecursively ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `isProductInSalesChannels`: Method isProductInSalesChannels ; `queryProducts`: Method queryProducts ; `queryProductsWithIds`: Method queryProductsWithIds }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantRepository_", + "type": "`Repository`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regionService_", + "type": "[`RegionService`](admin_discounts.internal.internal.RegionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.DELETED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addOptionValue + +▸ **addOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<[`ProductOptionValue`](admin_collections.internal.ProductOptionValue.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`ProductOptionValue`](admin_collections.internal.ProductOptionValue.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation.", + "children": [ + { + "name": "ProductOptionValue", + "type": "[`ProductOptionValue`](admin_collections.internal.ProductOptionValue.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### 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. + + + +#### Parameters + + + +#### Returns + +`Promise`<`TOutput`\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the creation result.", + "children": [] + } +]} /> + +___ + +### delete + +▸ **delete**(`variantIds`): `Promise`<`void`\> + +Deletes variant or variants. +Will never fail due to delete being idempotent. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "empty promise", + "children": [] + } +]} /> + +___ + +### deleteOptionValue + +▸ **deleteOptionValue**(`variantId`, `optionId`): `Promise`<`void`\> + +Deletes option value from given variant. +Will never fail due to delete being idempotent. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "empty promise", + "children": [] + } +]} /> + +___ + +### getFreeTextQueryBuilder\_ + +▸ **getFreeTextQueryBuilder_**(`variantRepo`, `query`, `q?`): `SelectQueryBuilder`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> + +Lists variants based on the provided parameters and includes the count of +variants that match the query. + +#### Parameters + +", + "description": "the variant repository", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "query", + "type": "[`FindWithRelationsOptions`](../../admin_discounts/modules/admin_discounts.internal.mdx#findwithrelationsoptions)", + "description": "object that defines the scope for what should be returned", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "q", + "type": "`string`", + "description": "free text query", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`SelectQueryBuilder`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "an array containing the products as the first element and the total\n count of products that matches the query as the second element.", + "children": [ + { + "name": "ProductVariant", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<``null`` \| `number`\> + +", + "optional": false, + "defaultValue": "", + "description": "the price specific to the region", + "children": [ + { + "name": "``null`` \\| number", + "type": "``null`` \\| `number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### isVariantInSalesChannels + +▸ **isVariantInSalesChannels**(`id`, `salesChannelIds`): `Promise`<`boolean`\> + +Check if the variant is assigned to at least one of the provided sales channels. + +#### Parameters + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> + +#### Parameters + + & [`PriceSelectionContext`](../modules/admin_discounts.internal.internal.mdx#priceselectioncontext)", + "description": "query config object for variant retrieval", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "ProductVariant[]", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariant", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[], `number`]\> + +#### Parameters + + & [`PriceSelectionContext`](../modules/admin_discounts.internal.internal.mdx#priceselectioncontext)", + "description": "query config object for variant retrieval", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "ProductVariant[]", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`variantId`, `config?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> + +Gets a product variant by id. + +#### Parameters + + & [`PriceSelectionContext`](../modules/admin_discounts.internal.internal.mdx#priceselectioncontext)", + "description": "query config object for variant retrieval.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the product document.", + "children": [ + { + "name": "ProductVariant", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveBySKU + +▸ **retrieveBySKU**(`sku`, `config?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> + +Gets a product variant by id. + +#### Parameters + + & [`PriceSelectionContext`](../modules/admin_discounts.internal.internal.mdx#priceselectioncontext)", + "description": "query config object for variant retrieval.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the product document.", + "children": [ + { + "name": "ProductVariant", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### setCurrencyPrice + +▸ **setCurrencyPrice**(`variantId`, `price`): `Promise`<[`MoneyAmount`](admin_collections.internal.MoneyAmount.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`MoneyAmount`](admin_collections.internal.MoneyAmount.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "MoneyAmount", + "type": "[`MoneyAmount`](admin_collections.internal.MoneyAmount.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +use addOrUpdateCurrencyPrices instead +Sets the default price for the given currency. + +___ + +### setRegionPrice + +▸ **setRegionPrice**(`variantId`, `price`): `Promise`<[`MoneyAmount`](admin_collections.internal.MoneyAmount.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`MoneyAmount`](admin_collections.internal.MoneyAmount.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "MoneyAmount", + "type": "[`MoneyAmount`](admin_collections.internal.MoneyAmount.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +use addOrUpdateRegionPrices instead +Sets the default price of a specific region + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`variantData`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> + +Updates a collection of variant. + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the update result.", + "children": [ + { + "name": "ProductVariant[]", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariant", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +▸ **update**(`variantOrVariantId`, `update`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> + +Updates a variant. +Price updates should use dedicated methods. +The function will throw, if price updates are attempted. + +#### Parameters + +", + "description": "variant or id of a variant.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "update", + "type": "[`UpdateProductVariantInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#updateproductvariantinput)", + "description": "an object with the update values.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the update result.", + "children": [ + { + "name": "ProductVariant", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +▸ **update**(`variantOrVariantId`, `update`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "update", + "type": "[`UpdateProductVariantInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#updateproductvariantinput)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariant", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateBatch + +▸ `Protected` **updateBatch**(`variantData`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariant[]", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductVariant", + "type": "[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### updateOptionValue + +▸ **updateOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<[`ProductOptionValue`](admin_collections.internal.ProductOptionValue.mdx)\> + +Updates variant's option value. +Option value must be of type string or number. + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductOptionValue`](admin_collections.internal.ProductOptionValue.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation.", + "children": [ + { + "name": "ProductOptionValue", + "type": "[`ProductOptionValue`](admin_collections.internal.ProductOptionValue.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "empty promise", + "children": [] + } +]} /> + +▸ **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 + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "empty promise", + "children": [] + } +]} /> + +___ + +### updateVariantPricesBatch + +▸ `Protected` **updateVariantPricesBatch**(`data`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### upsertCurrencyPrices + +▸ **upsertCurrencyPrices**(`data`): `Promise`<`void`\> + +#### Parameters + + ; `variantId`: `string` }[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### upsertRegionPrices + +▸ **upsertRegionPrices**(`data`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### validateVariantsToCreate\_ + +▸ `Protected` **validateVariantsToCreate_**(`product`, `variants`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductVariantService`](admin_discounts.internal.internal.ProductVariantService.mdx) + +#### Parameters + + + +#### Returns + +[`ProductVariantService`](admin_discounts.internal.internal.ProductVariantService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PublishableApiKey.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PublishableApiKey.mdx new file mode 100644 index 0000000000..d900796eae --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PublishableApiKey.mdx @@ -0,0 +1,80 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PublishableApiKey + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).PublishableApiKey + +Base abstract entity for all entities + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PublishableApiKeySalesChannel.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PublishableApiKeySalesChannel.mdx new file mode 100644 index 0000000000..844ee2f99c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PublishableApiKeySalesChannel.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PublishableApiKeySalesChannel + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).PublishableApiKeySalesChannel + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.RegionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.RegionService.mdx new file mode 100644 index 0000000000..81854fb702 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.RegionService.mdx @@ -0,0 +1,1290 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RegionService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).RegionService + +Provides layer to manipulate regions. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "countryRepository_", + "type": "`Repository`<[`Country`](admin_collections.internal.Country.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currencyRepository_", + "type": "`Repository`<[`Currency`](admin_collections.internal.Currency.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillmentProviderRepository_", + "type": "`Repository`<[`FulfillmentProvider`](admin_collections.internal.FulfillmentProvider.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillmentProviderService_", + "type": "[`FulfillmentProviderService`](admin_discounts.internal.internal.FulfillmentProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentProviderRepository_", + "type": "`Repository`<[`PaymentProvider`](admin_collections.internal.PaymentProvider.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentProviderService_", + "type": "[`PaymentProviderService`](admin_discounts.internal.internal.PaymentProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regionRepository_", + "type": "`Repository`<[`Region`](admin_collections.internal.Region.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "storeService_", + "type": "[`StoreService`](admin_discounts.internal.internal.StoreService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxProviderRepository_", + "type": "`Repository`<[`TaxProvider`](admin_collections.internal.TaxProvider.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.DELETED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addCountry + +▸ **addCountry**(`regionId`, `code`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +Adds a country to the region. + +#### Parameters + + + +#### Returns + +`Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated Region", + "children": [ + { + "name": "Region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### addFulfillmentProvider + +▸ **addFulfillmentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +Adds a fulfillment provider that is available in the region. Fails if the +provider doesn't exist. + +#### Parameters + + + +#### Returns + +`Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated Region", + "children": [ + { + "name": "Region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### addPaymentProvider + +▸ **addPaymentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +Adds a payment provider that is available in the region. Fails if the +provider doesn't exist. + +#### Parameters + + + +#### Returns + +`Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated Region", + "children": [ + { + "name": "Region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`data`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +Creates a region. + +#### Parameters + + + +#### Returns + +`Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the newly created region", + "children": [ + { + "name": "Region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`regionId`): `Promise`<`void`\> + +Deletes a region. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the delete operation", + "children": [] + } +]} /> + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)[]\> + +Lists all regions based on a query + +#### Parameters + +", + "description": "query object for find", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Region`](admin_collections.internal.Region.mdx)\\>", + "description": "configuration settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Region`](admin_collections.internal.Region.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "result of the find operation", + "children": [ + { + "name": "Region[]", + "type": "[`Region`](admin_collections.internal.Region.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`Region`](admin_collections.internal.Region.mdx)[], `number`]\> + +Lists all regions based on a query and returns them along with count + +#### Parameters + +", + "description": "query object for find", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Region`](admin_collections.internal.Region.mdx)\\>", + "description": "configuration settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`Region`](admin_collections.internal.Region.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "result of the find operation", + "children": [ + { + "name": "Region[]", + "type": "[`Region`](admin_collections.internal.Region.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeCountry + +▸ **removeCountry**(`regionId`, `code`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +Removes a country from a Region. + +#### Parameters + + + +#### Returns + +`Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated Region", + "children": [ + { + "name": "Region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeFulfillmentProvider + +▸ **removeFulfillmentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +Removes a fulfillment provider from a region. Is idempotent. + +#### Parameters + + + +#### Returns + +`Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated Region", + "children": [ + { + "name": "Region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### removePaymentProvider + +▸ **removePaymentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +Removes a payment provider from a region. Is idempotent. + +#### Parameters + + + +#### Returns + +`Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated Region", + "children": [ + { + "name": "Region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`regionId`, `config?`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +Retrieves a region by its id. + +#### Parameters + +", + "description": "configuration settings", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the region", + "children": [ + { + "name": "Region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByCountryCode + +▸ **retrieveByCountryCode**(`code`, `config?`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +Retrieve a region by country code. + +#### Parameters + +", + "description": "region find config", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "a Region with country code", + "children": [ + { + "name": "Region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByName + +▸ **retrieveByName**(`name`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +Retrieves a region by name. + +#### Parameters + + + +#### Returns + +`Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "region with the matching name", + "children": [ + { + "name": "Region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`regionId`, `update`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +Updates a region + +#### Parameters + + + +#### Returns + +`Promise`<[`Region`](admin_collections.internal.Region.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "Region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### validateCountry + +▸ `Protected` **validateCountry**(`code`, `regionId`): `Promise`<[`Country`](admin_collections.internal.Country.mdx)\> + +Validates a country code. Will normalize the code before checking for +existence. + +#### Parameters + + + +#### Returns + +`Promise`<[`Country`](admin_collections.internal.Country.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the validated Country", + "children": [ + { + "name": "Country", + "type": "[`Country`](admin_collections.internal.Country.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### validateCurrency + +▸ `Protected` **validateCurrency**(`currencyCode`): `Promise`<`void`\> + +Validates a currency code. Will throw if the currency code doesn't exist. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "void", + "children": [] + } +]} /> + +#### Throws + +if the provided currency code is invalid + +___ + +### validateFields + +▸ `Protected` **validateFields**<`T`\>(`regionData`, `id?`): `Promise`<`DeepPartial`<[`Region`](admin_collections.internal.Region.mdx)\>\> + +Validates fields for creation and updates. If the region already exists +the id can be passed to check that country updates are allowed. + + + +#### Parameters + +", + "description": "the region data to validate", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`T` extends [`UpdateRegionInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#updateregioninput) ? `string` : `undefined`", + "description": "optional id of the region to check against", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`DeepPartial`<[`Region`](admin_collections.internal.Region.mdx)\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "the validated region data", + "children": [ + { + "name": "DeepPartial", + "type": "`DeepPartial`<[`Region`](admin_collections.internal.Region.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Region", + "type": "[`Region`](admin_collections.internal.Region.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### validateTaxRate + +▸ `Protected` **validateTaxRate**(`taxRate`): `void` + +Validates a tax rate. Will throw if the tax rate is not between 0 and 1. + +#### Parameters + + + +#### Returns + +`void` + + + +#### Throws + +if the tax rate isn't number between 0-100 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`RegionService`](admin_discounts.internal.internal.RegionService.mdx) + +#### Parameters + + + +#### Returns + +[`RegionService`](admin_discounts.internal.internal.RegionService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnReasonService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnReasonService.mdx new file mode 100644 index 0000000000..af93d65244 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnReasonService.mdx @@ -0,0 +1,481 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnReasonService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ReturnReasonService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "retReasonRepo_", + "type": "`Repository`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`data`): `Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReturnReason", + "type": "[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`returnReasonId`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)[]\> + +#### Parameters + +", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\\>", + "description": "config object", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "ReturnReason[]", + "type": "[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReturnReason", + "type": "[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`returnReasonId`, `config?`): `Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\> + +Gets an order by id. + +#### Parameters + +", + "description": "config object", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the order document", + "children": [ + { + "name": "ReturnReason", + "type": "[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`id`, `data`): `Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReturnReason", + "type": "[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ReturnReasonService`](admin_discounts.internal.internal.ReturnReasonService.mdx) + +#### Parameters + + + +#### Returns + +[`ReturnReasonService`](admin_discounts.internal.internal.ReturnReasonService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnService.mdx new file mode 100644 index 0000000000..9c629731c5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnService.mdx @@ -0,0 +1,1011 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ReturnService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillmentProviderService_", + "type": "[`FulfillmentProviderService`](admin_discounts.internal.internal.FulfillmentProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemService_", + "type": "[`LineItemService`](admin_discounts.internal.internal.LineItemService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orderService_", + "type": "[`OrderService`](admin_discounts.internal.internal.OrderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantInventoryService_", + "type": "[`ProductVariantInventoryService`](admin_discounts.internal.internal.ProductVariantInventoryService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnItemRepository_", + "type": "`Repository`<[`ReturnItem`](admin_collections.internal.ReturnItem.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnReasonService_", + "type": "[`ReturnReasonService`](admin_discounts.internal.internal.ReturnReasonService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnRepository_", + "type": "`Repository`<[`Return`](admin_collections.internal.Return.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingOptionService_", + "type": "[`ShippingOptionService`](admin_discounts.internal.internal.ShippingOptionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxProviderService_", + "type": "[`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "totalsService_", + "type": "[`TotalsService`](admin_discounts.internal.internal.TotalsService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### cancel + +▸ **cancel**(`returnId`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +Cancels a return if possible. Returns can be canceled if it has not been received. + +#### Parameters + + + +#### Returns + +`Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated Return", + "children": [ + { + "name": "Return", + "type": "[`Return`](admin_collections.internal.Return.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`data`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the created return", + "children": [ + { + "name": "Return", + "type": "[`Return`](admin_collections.internal.Return.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### fulfill + +▸ **fulfill**(`returnId`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Return", + "type": "[`Return`](admin_collections.internal.Return.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getFulfillmentItems + +▸ `Protected` **getFulfillmentItems**(`order`, `items`, `transformer`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx) & { `note?`: `string` ; `reason_id?`: `string` }[]\> + +Retrieves the order line items, given an array of items + +#### Parameters + + + +#### Returns + +`Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx) & { `note?`: `string` ; `reason_id?`: `string` }[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the line items generated by the transformer.", + "children": [ + { + "name": "[`LineItem`](admin_collections.internal.LineItem.mdx) & { `note?`: `string` ; `reason_id?`: `string` }[]", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx) & { `note?`: `string` ; `reason_id?`: `string` }[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "[`LineItem`](admin_collections.internal.LineItem.mdx) & { `note?`: `string` ; `reason_id?`: `string` }", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx) & { `note?`: `string` ; `reason_id?`: `string` }", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)[]\> + +#### Parameters + +", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Return`](admin_collections.internal.Return.mdx)\\>", + "description": "the config object for find", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Return`](admin_collections.internal.Return.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "Return[]", + "type": "[`Return`](admin_collections.internal.Return.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Return", + "type": "[`Return`](admin_collections.internal.Return.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Return`](admin_collections.internal.Return.mdx)[], `number`]\> + +#### Parameters + +", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Return`](admin_collections.internal.Return.mdx)\\>", + "description": "the config object for find", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`Return`](admin_collections.internal.Return.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "Return[]", + "type": "[`Return`](admin_collections.internal.Return.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### receive + +▸ **receive**(`returnId`, `receivedItems`, `refundAmount?`, `allowMismatch?`, `context?`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "Return", + "type": "[`Return`](admin_collections.internal.Return.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`returnId`, `config?`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +Retrieves a return by its id. + +#### Parameters + +", + "description": "the config object", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the return", + "children": [ + { + "name": "Return", + "type": "[`Return`](admin_collections.internal.Return.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveBySwap + +▸ **retrieveBySwap**(`swapId`, `relations?`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Return", + "type": "[`Return`](admin_collections.internal.Return.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`returnId`, `update`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Return`](admin_collections.internal.Return.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Return", + "type": "[`Return`](admin_collections.internal.Return.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### validateReturnLineItem + +▸ `Protected` **validateReturnLineItem**(`item?`, `quantity?`, `additional?`): `DeepPartial`<[`LineItem`](admin_collections.internal.LineItem.mdx)\> + +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 + + + +#### Returns + +`DeepPartial`<[`LineItem`](admin_collections.internal.LineItem.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "a line item where the quantity is set to the requested\n return quantity.", + "children": [ + { + "name": "LineItem", + "type": "[`LineItem`](admin_collections.internal.LineItem.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`void` + + + +#### Throws + +when statuses are not sufficient for returns. + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ReturnService`](admin_discounts.internal.internal.ReturnService.mdx) + +#### Parameters + + + +#### Returns + +[`ReturnService`](admin_discounts.internal.internal.ReturnService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelInventoryService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelInventoryService.mdx new file mode 100644 index 0000000000..d7c22ca730 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelInventoryService.mdx @@ -0,0 +1,309 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SalesChannelInventoryService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).SalesChannelInventoryService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBusService_", + "type": "[`IEventBusService`](../interfaces/admin_discounts.internal.IEventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventoryService_", + "type": "[`IInventoryService`](../interfaces/admin_discounts.internal.IInventoryService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "salesChannelLocationService_", + "type": "[`SalesChannelLocationService`](admin_discounts.internal.internal.SalesChannelLocationService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### retrieveAvailableItemQuantity + +▸ **retrieveAvailableItemQuantity**(`salesChannelId`, `inventoryItemId`): `Promise`<`number`\> + +Retrieves the available quantity of an item across all sales channel locations + +#### Parameters + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "available quantity of item across all sales channel locations", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`SalesChannelInventoryService`](admin_discounts.internal.internal.SalesChannelInventoryService.mdx) + +#### Parameters + + + +#### Returns + +[`SalesChannelInventoryService`](admin_discounts.internal.internal.SalesChannelInventoryService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelLocationService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelLocationService.mdx new file mode 100644 index 0000000000..b21f5f7cd1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelLocationService.mdx @@ -0,0 +1,454 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SalesChannelLocationService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).SalesChannelLocationService + +Service for managing the stock locations of sales channels + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBusService_", + "type": "[`IEventBusService`](../interfaces/admin_discounts.internal.IEventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "salesChannelService_", + "type": "[`SalesChannelService`](admin_discounts.internal.internal.SalesChannelService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "stockLocationService_", + "type": "[`IStockLocationService`](../interfaces/admin_discounts.internal.IStockLocationService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### associateLocation + +▸ **associateLocation**(`salesChannelId`, `locationId`): `Promise`<`void`\> + +Associates a sales channel with a stock location. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "A promise that resolves when the association has been created.", + "children": [] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### listLocationIds + +▸ **listLocationIds**(`salesChannelId`): `Promise`<`string`[]\> + +Lists the stock locations associated with a sales channel. + +#### Parameters + + + +#### Returns + +`Promise`<`string`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "A promise that resolves with an array of location IDs.", + "children": [ + { + "name": "string[]", + "type": "`string`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listSalesChannelIds + +▸ **listSalesChannelIds**(`locationId`): `Promise`<`string`[]\> + +Lists the sales channels associated with a stock location. + +#### Parameters + + + +#### Returns + +`Promise`<`string`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "A promise that resolves with an array of sales channel IDs.", + "children": [ + { + "name": "string[]", + "type": "`string`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### removeLocation + +▸ **removeLocation**(`locationId`, `salesChannelId?`): `Promise`<`void`\> + +Removes an association between a sales channel and a stock location. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "A promise that resolves when the association has been removed.", + "children": [] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`SalesChannelLocationService`](admin_discounts.internal.internal.SalesChannelLocationService.mdx) + +#### Parameters + + + +#### Returns + +[`SalesChannelLocationService`](admin_discounts.internal.internal.SalesChannelLocationService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelService.mdx new file mode 100644 index 0000000000..ee30117ee5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelService.mdx @@ -0,0 +1,861 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SalesChannelService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).SalesChannelService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBusService_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "salesChannelRepository_", + "type": "`Repository`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\\> & { `addProducts`: Method addProducts ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `listProductIdsBySalesChannelIds`: Method listProductIdsBySalesChannelIds ; `removeProducts`: Method removeProducts }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "storeService_", + "type": "[`StoreService`](admin_discounts.internal.internal.StoreService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.DELETED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addProducts + +▸ **addProducts**(`salesChannelId`, `productIds`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +Add a batch of product to a sales channel + +#### Parameters + + + +#### Returns + +`Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the sales channel on which the products have been added", + "children": [ + { + "name": "SalesChannel", + "type": "[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`data`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the created channel", + "children": [ + { + "name": "SalesChannel", + "type": "[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createDefault + +▸ **createDefault**(): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +Creates a default sales channel, if this does not already exist. + +#### Returns + +`Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the sales channel", + "children": [ + { + "name": "SalesChannel", + "type": "[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)[], `number`]\> + +Lists sales channels based on the provided parameters and includes the count of +sales channels that match the query. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "an array containing the sales channels as\n the first element and the total count of sales channels that matches the query\n as the second element.", + "children": [ + { + "name": "SalesChannel[]", + "type": "[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### listProductIdsBySalesChannelIds + +▸ **listProductIdsBySalesChannelIds**(`salesChannelIds`): `Promise`<{ `[salesChannelId: string]`: `string`[]; }\> + +List all product ids that belongs to the sales channels ids + +#### Parameters + + + +#### Returns + +`Promise`<{ `[salesChannelId: string]`: `string`[]; }\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "`object`", + "type": "`object`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeProducts + +▸ **removeProducts**(`salesChannelId`, `productIds`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +Remove a batch of product from a sales channel + +#### Parameters + + + +#### Returns + +`Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the sales channel on which the products have been removed", + "children": [ + { + "name": "SalesChannel", + "type": "[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`salesChannelId`, `config?`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +Retrieve a SalesChannel by id + +#### Parameters + +", + "description": "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.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "a sales channel", + "children": [ + { + "name": "SalesChannel", + "type": "[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByName + +▸ **retrieveByName**(`name`, `config?`): `Promise`<`unknown`\> + +Find a sales channel by name. + +#### Parameters + +", + "description": "find config", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`unknown`\> + +", + "optional": false, + "defaultValue": "", + "description": "a sales channel with matching name", + "children": [ + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveDefault + +▸ **retrieveDefault**(): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +Retrieves the default sales channel. + +#### Returns + +`Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the sales channel", + "children": [ + { + "name": "SalesChannel", + "type": "[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve\_ + +▸ `Protected` **retrieve_**(`selector`, `config?`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +A generic retrieve used to find a sales channel by different attributes. + +#### Parameters + +", + "description": "SC selector", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\\>", + "description": "find config", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "a single SC matching the query or throws", + "children": [ + { + "name": "SalesChannel", + "type": "[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`salesChannelId`, `data`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "SalesChannel", + "type": "[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`SalesChannelService`](admin_discounts.internal.internal.SalesChannelService.mdx) + +#### Parameters + + + +#### Returns + +[`SalesChannelService`](admin_discounts.internal.internal.SalesChannelService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SearchService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SearchService.mdx new file mode 100644 index 0000000000..524aa9597e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SearchService.mdx @@ -0,0 +1,481 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SearchService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).SearchService + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### options + +• `get` **options**(): Record<`string`, `unknown`\> + +#### Returns + +Record<`string`, `unknown`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +AbstractSearchService.options + +## Methods + +### addDocuments + +▸ **addDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\> + +Used to index documents by the search engine provider + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "returns response from search engine provider", + "children": [] + } +]} /> + +#### Overrides + +[AbstractSearchService](admin_discounts.internal.AbstractSearchService.mdx).[addDocuments](admin_discounts.internal.AbstractSearchService.mdx#adddocuments) + +___ + +### createIndex + +▸ **createIndex**(`indexName`, `options`): `Promise`<`void`\> + +Used to create an index + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "returns response from search engine provider", + "children": [] + } +]} /> + +#### Overrides + +[AbstractSearchService](admin_discounts.internal.AbstractSearchService.mdx).[createIndex](admin_discounts.internal.AbstractSearchService.mdx#createindex) + +___ + +### deleteAllDocuments + +▸ **deleteAllDocuments**(`indexName`): `Promise`<`void`\> + +Used to delete all documents + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "returns response from search engine provider", + "children": [] + } +]} /> + +#### Overrides + +[AbstractSearchService](admin_discounts.internal.AbstractSearchService.mdx).[deleteAllDocuments](admin_discounts.internal.AbstractSearchService.mdx#deletealldocuments) + +___ + +### deleteDocument + +▸ **deleteDocument**(`indexName`, `document_id`): `Promise`<`void`\> + +Used to delete document + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "returns response from search engine provider", + "children": [] + } +]} /> + +#### Overrides + +[AbstractSearchService](admin_discounts.internal.AbstractSearchService.mdx).[deleteDocument](admin_discounts.internal.AbstractSearchService.mdx#deletedocument) + +___ + +### getIndex + +▸ **getIndex**(`indexName`): `Promise`<`void`\> + +Used to get an index + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "returns response from search engine provider", + "children": [] + } +]} /> + +#### Overrides + +[AbstractSearchService](admin_discounts.internal.AbstractSearchService.mdx).[getIndex](admin_discounts.internal.AbstractSearchService.mdx#getindex) + +___ + +### replaceDocuments + +▸ **replaceDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\> + +Used to replace documents + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "returns response from search engine provider", + "children": [] + } +]} /> + +#### Overrides + +[AbstractSearchService](admin_discounts.internal.AbstractSearchService.mdx).[replaceDocuments](admin_discounts.internal.AbstractSearchService.mdx#replacedocuments) + +___ + +### search + +▸ **search**(`indexName`, `query`, `options`): `Promise`<{ `hits`: `unknown`[] }\> + +Used to search for a document in an index + +#### Parameters + + + +#### Returns + +`Promise`<{ `hits`: `unknown`[] }\> + +", + "optional": false, + "defaultValue": "", + "description": "returns response from search engine provider", + "children": [ + { + "name": "`object`", + "type": "`object`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Overrides + +[AbstractSearchService](admin_discounts.internal.AbstractSearchService.mdx).[search](admin_discounts.internal.AbstractSearchService.mdx#search) + +___ + +### updateSettings + +▸ **updateSettings**(`indexName`, `settings`): `Promise`<`void`\> + +Used to update the settings of an index + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "returns response from search engine provider", + "children": [] + } +]} /> + +#### Overrides + +[AbstractSearchService](admin_discounts.internal.AbstractSearchService.mdx).[updateSettings](admin_discounts.internal.AbstractSearchService.mdx#updatesettings) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingAddressPayload.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingAddressPayload.mdx new file mode 100644 index 0000000000..99859eb83a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingAddressPayload.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingAddressPayload + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ShippingAddressPayload + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingOptionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingOptionService.mdx new file mode 100644 index 0000000000..78a861a7d2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingOptionService.mdx @@ -0,0 +1,1170 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingOptionService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ShippingOptionService + +Provides layer to manipulate profiles. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "methodRepository_", + "type": "`Repository`<[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "optionRepository_", + "type": "`Repository`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\\> & { `upsertShippingProfile`: Method upsertShippingProfile }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "providerService_", + "type": "[`FulfillmentProviderService`](admin_discounts.internal.internal.FulfillmentProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regionService_", + "type": "[`RegionService`](admin_discounts.internal.internal.RegionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirementRepository_", + "type": "`Repository`<[`ShippingOptionRequirement`](admin_collections.internal.ShippingOptionRequirement.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "validateAndMutatePrice", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addRequirement + +▸ **addRequirement**(`optionId`, `requirement`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> + +Adds a requirement to a shipping option. Only 1 requirement of each type +is allowed. + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of update", + "children": [ + { + "name": "ShippingOption", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`data`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the create operation", + "children": [ + { + "name": "ShippingOption", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createShippingMethod + +▸ **createShippingMethod**(`optionId`, `data`, `config`): `Promise`<[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)\> + +Creates a shipping method for a given cart. + +#### Parameters + +", + "description": "the optional provider data to use.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`CreateShippingMethodDto`](../../admin_discounts/modules/admin_discounts.internal.mdx#createshippingmethoddto)", + "description": "the cart to create the shipping method for.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the resulting shipping method.", + "children": [ + { + "name": "ShippingMethod", + "type": "[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`optionId`): `Promise`<`void` \| [`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> + +Deletes a profile with a given profile id. + +#### Parameters + + + +#### Returns + +`Promise`<`void` \| [`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the delete operation.", + "children": [ + { + "name": "void \\| ShippingOption", + "type": "`void` \\| [`ShippingOption`](admin_collections.internal.ShippingOption.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteShippingMethods + +▸ **deleteShippingMethods**(`shippingMethods`): `Promise`<[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)[]\> + +Removes a given shipping method + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "removed shipping methods", + "children": [ + { + "name": "ShippingMethod[]", + "type": "[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingMethod", + "type": "[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### 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 + +", + "description": "the shipping data to retrieve the price.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "`undefined` \\| [`Order`](admin_collections.internal.Order.mdx) \\| [`Cart`](admin_collections.internal.Cart.mdx)", + "description": "the context in which the price should be retrieved.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "the price of the shipping option.", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]\> + +#### Parameters + +", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\\>", + "description": "config object", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "ShippingOption[]", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingOption", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[], `number`]\> + +#### Parameters + +", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\\>", + "description": "config object", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "ShippingOption[]", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeRequirement + +▸ **removeRequirement**(`requirementId`): `Promise`<`void` \| [`ShippingOptionRequirement`](admin_collections.internal.ShippingOptionRequirement.mdx)\> + +Removes a requirement from a shipping option + +#### Parameters + + + +#### Returns + +`Promise`<`void` \| [`ShippingOptionRequirement`](admin_collections.internal.ShippingOptionRequirement.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of update", + "children": [ + { + "name": "void \\| ShippingOptionRequirement", + "type": "`void` \\| [`ShippingOptionRequirement`](admin_collections.internal.ShippingOptionRequirement.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`optionId`, `options?`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> + +Gets a profile by id. +Throws in case of DB Error and if profile was not found. + +#### Parameters + +", + "description": "the options to get a profile", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the profile document.", + "children": [ + { + "name": "ShippingOption", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`optionId`, `update`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the update result.", + "children": [ + { + "name": "ShippingOption", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateShippingMethod + +▸ **updateShippingMethod**(`id`, `update`): `Promise`<`undefined` \| [`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)\> + +Updates a shipping method's associations. Useful when a cart is completed +and its methods should be copied to an order/swap entity. + +#### Parameters + + + +#### Returns + +`Promise`<`undefined` \| [`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the resulting shipping method", + "children": [ + { + "name": "undefined \\| ShippingMethod", + "type": "`undefined` \\| [`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateShippingProfile + +▸ **updateShippingProfile**(`optionIds`, `profileId`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "updated shipping options", + "children": [ + { + "name": "ShippingOption[]", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingOption", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### validateCartOption + +▸ **validateCartOption**(`option`, `cart`): `Promise`<``null`` \| [`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> + +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 + + + +#### Returns + +`Promise`<``null`` \| [`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the validated shipping option", + "children": [ + { + "name": "``null`` \\| ShippingOption", + "type": "``null`` \\| [`ShippingOption`](admin_collections.internal.ShippingOption.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### validatePriceType\_ + +▸ **validatePriceType_**(`priceType`, `option`): `Promise`<[`ShippingOptionPriceType`](../enums/admin_collections.internal.ShippingOptionPriceType.mdx)\> + +Validates a shipping option price + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingOptionPriceType`](../enums/admin_collections.internal.ShippingOptionPriceType.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the validated price", + "children": [ + { + "name": "CALCULATED", + "type": "``\"calculated\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FLAT_RATE", + "type": "``\"flat_rate\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### validateRequirement\_ + +▸ **validateRequirement_**(`requirement`, `optionId?`): `Promise`<[`ShippingOptionRequirement`](admin_collections.internal.ShippingOptionRequirement.mdx)\> + +Validates a requirement + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingOptionRequirement`](admin_collections.internal.ShippingOptionRequirement.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "a validated shipping requirement", + "children": [ + { + "name": "ShippingOptionRequirement", + "type": "[`ShippingOptionRequirement`](admin_collections.internal.ShippingOptionRequirement.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ShippingOptionService`](admin_discounts.internal.internal.ShippingOptionService.mdx) + +#### Parameters + + + +#### Returns + +[`ShippingOptionService`](admin_discounts.internal.internal.ShippingOptionService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingProfileService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingProfileService.mdx new file mode 100644 index 0000000000..640c4c1638 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingProfileService.mdx @@ -0,0 +1,1088 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingProfileService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ShippingProfileService + +Provides layer to manipulate profiles. + +#### Implements + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "customShippingOptionService_", + "type": "[`CustomShippingOptionService`](admin_discounts.internal.internal.CustomShippingOptionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productRepository_", + "type": "`Repository`<[`Product`](admin_collections.internal.Product.mdx)\\> & { `_applyCategoriesQuery`: Method \\_applyCategoriesQuery ; `_findWithRelations`: Method \\_findWithRelations ; `bulkAddToCollection`: Method bulkAddToCollection ; `bulkRemoveFromCollection`: Method bulkRemoveFromCollection ; `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations ; `findWithRelationsAndCount`: Method findWithRelationsAndCount ; `getCategoryIdsFromInput`: Method getCategoryIdsFromInput ; `getCategoryIdsRecursively`: Method getCategoryIdsRecursively ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `isProductInSalesChannels`: Method isProductInSalesChannels ; `queryProducts`: Method queryProducts ; `queryProductsWithIds`: Method queryProductsWithIds }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productService_", + "type": "[`ProductService`](admin_discounts.internal.internal.ProductService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingOptionService_", + "type": "[`ShippingOptionService`](admin_discounts.internal.internal.ShippingOptionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingProfileRepository_", + "type": "`Repository`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\\> & { `findByProducts`: Method findByProducts }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addProduct + +▸ **addProduct**(`profileId`, `productId`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingProfile", + "type": "[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +use [addProducts](admin_discounts.internal.internal.ShippingProfileService.mdx#addproducts) instead + +___ + +### addProducts + +▸ **addProducts**(`profileId`, `productId`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +Adds a product or an array of products to the profile. + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of update", + "children": [ + { + "name": "ShippingProfile", + "type": "[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### addShippingOption + +▸ **addShippingOption**(`profileId`, `optionId`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +Adds a shipping option to the profile. The shipping option can be used to +fulfill the products in the products field. + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the model update operation", + "children": [ + { + "name": "ShippingProfile", + "type": "[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`profile`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +Creates a new shipping profile. + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the create operation", + "children": [ + { + "name": "ShippingProfile", + "type": "[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createDefault + +▸ **createDefault**(): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +Creates a default shipping profile, if this does not already exist. + +#### Returns + +`Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the shipping profile", + "children": [ + { + "name": "ShippingProfile", + "type": "[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createGiftCardDefault + +▸ **createGiftCardDefault**(): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +Creates a default shipping profile, for gift cards if unless it already +exists. + +#### Returns + +`Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the shipping profile", + "children": [ + { + "name": "ShippingProfile", + "type": "[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`profileId`): `Promise`<`void`\> + +Deletes a profile with a given profile id. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the delete operation.", + "children": [] + } +]} /> + +___ + +### fetchCartOptions + +▸ **fetchCartOptions**(`cart`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]\> + +Finds all the shipping profiles that cover the products in a cart, and +validates all options that are available for the cart. + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "a list of the available shipping options", + "children": [ + { + "name": "ShippingOption[]", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingOption", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### getMapProfileIdsByProductIds + +▸ **getMapProfileIdsByProductIds**(`productIds`): `Promise`<`Map`<`string`, `string`\>\> + +#### Parameters + + + +#### Returns + +`Promise`<`Map`<`string`, `string`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Map", + "type": "`Map`<`string`, `string`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### getProfilesInCart + +▸ `Protected` **getProfilesInCart**(`cart`): `Promise`<`string`[]\> + +Returns a list of all the productIds in the cart. + +#### Parameters + + + +#### Returns + +`Promise`<`string`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "a list of product ids", + "children": [ + { + "name": "string[]", + "type": "`string`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)[]\> + +#### Parameters + +", + "description": "the query object for find", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\\>", + "description": "the config object for find", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "ShippingProfile[]", + "type": "[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingProfile", + "type": "[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### removeProducts + +▸ **removeProducts**(`profileId`, `productId`): `Promise`<`void` \| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +Removes a product or an array of products from the profile. + +#### Parameters + + + +#### Returns + +`Promise`<`void` \| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of update", + "children": [ + { + "name": "void \\| ShippingProfile", + "type": "`void` \\| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`profileId`, `options?`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +Gets a profile by id. +Throws in case of DB Error and if profile was not found. + +#### Parameters + +", + "description": "options opf the query.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the profile document.", + "children": [ + { + "name": "ShippingProfile", + "type": "[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveDefault + +▸ **retrieveDefault**(): `Promise`<``null`` \| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +#### Returns + +`Promise`<``null`` \| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "``null`` \\| ShippingProfile", + "type": "``null`` \\| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveForProducts + +▸ **retrieveForProducts**(`productIds`): `Promise`<{ `[product_id: string]`: [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)[]; }\> + +#### Parameters + + + +#### Returns + +`Promise`<{ `[product_id: string]`: [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)[]; }\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "`object`", + "type": "`object`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveGiftCardDefault + +▸ **retrieveGiftCardDefault**(): `Promise`<``null`` \| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +Retrieves the default gift card profile + +#### Returns + +`Promise`<``null`` \| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the shipping profile for gift cards", + "children": [ + { + "name": "``null`` \\| ShippingProfile", + "type": "``null`` \\| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`profileId`, `update`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the update result.", + "children": [ + { + "name": "ShippingProfile", + "type": "[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ShippingProfileService`](admin_discounts.internal.internal.ShippingProfileService.mdx) + +#### Parameters + + + +#### Returns + +[`ShippingProfileService`](admin_discounts.internal.internal.ShippingProfileService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingTaxRate.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingTaxRate.mdx new file mode 100644 index 0000000000..183a9f32a7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingTaxRate.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingTaxRate + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ShippingTaxRate + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "[`TaxRate`](admin_collections.internal.TaxRate.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StagedJob.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StagedJob.mdx new file mode 100644 index 0000000000..c86091502e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StagedJob.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StagedJob + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StagedJob + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "event_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StagedJobService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StagedJobService.mdx new file mode 100644 index 0000000000..09d381da31 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StagedJobService.mdx @@ -0,0 +1,380 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StagedJobService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StagedJobService + +Provides layer to manipulate users. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "stagedJobRepository_", + "type": "`Repository`<[`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)\\> & { `insertBulk`: Method insertBulk }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`data`): `Promise`<[`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> + +#### Parameters + + \\| [`EmitData`](../../admin_discounts/modules/admin_discounts.internal.mdx#emitdata)<`unknown`\\>[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StagedJob[]", + "type": "[`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StagedJob", + "type": "[`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`stagedJobIds`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### list + +▸ **list**(`config`): `Promise`<[`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StagedJob[]", + "type": "[`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StagedJob", + "type": "[`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`StagedJobService`](admin_discounts.internal.internal.StagedJobService.mdx) + +#### Parameters + + + +#### Returns + +[`StagedJobService`](admin_discounts.internal.internal.StagedJobService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Store.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Store.mdx new file mode 100644 index 0000000000..08d81b3ad2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.Store.mdx @@ -0,0 +1,136 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Store + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).Store + +Base abstract entity for all entities + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_link_template", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_link_template", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetCollectionsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetCollectionsParams.mdx new file mode 100644 index 0000000000..3f71ed41b3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetCollectionsParams.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetCollectionsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetCollectionsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetCustomersCustomerOrdersPaginationParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetCustomersCustomerOrdersPaginationParams.mdx new file mode 100644 index 0000000000..81cf0c7dd2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetCustomersCustomerOrdersPaginationParams.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetCustomersCustomerOrdersPaginationParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetCustomersCustomerOrdersPaginationParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetCustomersCustomerOrdersParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetCustomersCustomerOrdersParams.mdx new file mode 100644 index 0000000000..ee462cdabf --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetCustomersCustomerOrdersParams.mdx @@ -0,0 +1,158 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetCustomersCustomerOrdersParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetCustomersCustomerOrdersParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetOrdersParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetOrdersParams.mdx new file mode 100644 index 0000000000..8652e99af3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetOrdersParams.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetOrdersParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetOrdersParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetPaymentCollectionsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetPaymentCollectionsParams.mdx new file mode 100644 index 0000000000..2b5e766769 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetPaymentCollectionsParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetPaymentCollectionsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetPaymentCollectionsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductCategoriesCategoryParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductCategoriesCategoryParams.mdx new file mode 100644 index 0000000000..1801b3c17a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductCategoriesCategoryParams.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetProductCategoriesCategoryParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetProductCategoriesCategoryParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductCategoriesParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductCategoriesParams.mdx new file mode 100644 index 0000000000..5a78fdf2ff --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductCategoriesParams.mdx @@ -0,0 +1,78 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetProductCategoriesParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetProductCategoriesParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductTagsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductTagsParams.mdx new file mode 100644 index 0000000000..ec05156432 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductTagsParams.mdx @@ -0,0 +1,86 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetProductTagsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetProductTagsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductTypesParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductTypesParams.mdx new file mode 100644 index 0000000000..2cfc7550d7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductTypesParams.mdx @@ -0,0 +1,86 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetProductTypesParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetProductTypesParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductsPaginationParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductsPaginationParams.mdx new file mode 100644 index 0000000000..b7e5f3ee2e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductsPaginationParams.mdx @@ -0,0 +1,78 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetProductsPaginationParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetProductsPaginationParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductsParams.mdx new file mode 100644 index 0000000000..5f3d0b17d9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetProductsParams.mdx @@ -0,0 +1,190 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetProductsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetProductsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetRegionsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetRegionsParams.mdx new file mode 100644 index 0000000000..8a0b37c7eb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetRegionsParams.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetRegionsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetRegionsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetShippingOptionsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetShippingOptionsParams.mdx new file mode 100644 index 0000000000..85ec395d26 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetShippingOptionsParams.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetShippingOptionsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetShippingOptionsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetVariantsParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetVariantsParams.mdx new file mode 100644 index 0000000000..c9b1db4cab --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetVariantsParams.mdx @@ -0,0 +1,110 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetVariantsParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetVariantsParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetVariantsVariantParams.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetVariantsVariantParams.mdx new file mode 100644 index 0000000000..f40b96470b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreGetVariantsVariantParams.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreGetVariantsVariantParams + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreGetVariantsVariantParams + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePaymentCollectionSessionsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePaymentCollectionSessionsReq.mdx new file mode 100644 index 0000000000..adadb0b648 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePaymentCollectionSessionsReq.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePaymentCollectionSessionsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePaymentCollectionSessionsReq + +#### Schema + +StorePaymentCollectionSessionsReq +type: object +required: + - provider_id +properties: + provider_id: + type: string + description: The ID of the Payment Provider. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostAuthReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostAuthReq.mdx new file mode 100644 index 0000000000..d5e5220307 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostAuthReq.mdx @@ -0,0 +1,45 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostAuthReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartReq.mdx new file mode 100644 index 0000000000..25f7d6814c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartReq.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCartReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostCartReq + +#### Schema + +The 2 character ISO country code to create the Cart in. Setting this parameter will set the country code of the shipping address.`context` field is automatically populated with `ip` and `user_agent`" + type: object + example: + ip: "::1" + user_agent: "Chrome" + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartLineItemsItemReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartLineItemsItemReq.mdx new file mode 100644 index 0000000000..f510aed66d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartLineItemsItemReq.mdx @@ -0,0 +1,34 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCartsCartLineItemsItemReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostCartsCartLineItemsItemReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartLineItemsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartLineItemsReq.mdx new file mode 100644 index 0000000000..c8096644e6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartLineItemsReq.mdx @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCartsCartLineItemsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostCartsCartLineItemsReq + +#### Schema + +Learn about the metadata attribute, and how to delete and update it. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartPaymentSessionReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartPaymentSessionReq.mdx new file mode 100644 index 0000000000..fe5c879f31 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartPaymentSessionReq.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCartsCartPaymentSessionReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostCartsCartPaymentSessionReq + +#### Schema + +StorePostCartsCartPaymentSessionReq +type: object +required: + - provider_id +properties: + provider_id: + type: string + description: The ID of the Payment Provider. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartPaymentSessionUpdateReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartPaymentSessionUpdateReq.mdx new file mode 100644 index 0000000000..afda5bd4db --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartPaymentSessionUpdateReq.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCartsCartPaymentSessionUpdateReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostCartsCartPaymentSessionUpdateReq + +#### Schema + +StorePostCartsCartPaymentSessionUpdateReq +type: object +required: + - data +properties: + data: + type: object + description: The data to update the payment session with. + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartReq.mdx new file mode 100644 index 0000000000..2a77e47d51 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartReq.mdx @@ -0,0 +1,102 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCartsCartReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostCartsCartReq + +#### Schema + +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.`context` field is automatically populated with `ip` and `user_agent`" + type: object + example: + ip: "::1" + user_agent: "Chrome" + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartShippingMethodReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartShippingMethodReq.mdx new file mode 100644 index 0000000000..7d2d3602f4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCartsCartShippingMethodReq.mdx @@ -0,0 +1,44 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCartsCartShippingMethodReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerAcceptClaimReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerAcceptClaimReq.mdx new file mode 100644 index 0000000000..774785a7b0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerAcceptClaimReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCustomersCustomerAcceptClaimReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostCustomersCustomerAcceptClaimReq + +#### Schema + +The claim token generated by previous request to the Claim Order API Route. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerOrderClaimReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerOrderClaimReq.mdx new file mode 100644 index 0000000000..ec3d100b79 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerOrderClaimReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCustomersCustomerOrderClaimReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostCustomersCustomerOrderClaimReq + +#### Schema + +The ID of the orders to claim + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerPasswordTokenReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerPasswordTokenReq.mdx new file mode 100644 index 0000000000..7bd78f0ca7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerPasswordTokenReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCustomersCustomerPasswordTokenReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostCustomersCustomerPasswordTokenReq + +#### Schema + +The customer's email. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerReq.mdx new file mode 100644 index 0000000000..366c701f59 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerReq.mdx @@ -0,0 +1,74 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCustomersCustomerReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostCustomersCustomerReq + +#### Schema + +The customer's first name. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "password", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersReq.mdx new file mode 100644 index 0000000000..a950c820a1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersReq.mdx @@ -0,0 +1,58 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCustomersReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostCustomersReq + +#### Schema + +The customer's first name. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersResetPasswordReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersResetPasswordReq.mdx new file mode 100644 index 0000000000..2a96bf49af --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostCustomersResetPasswordReq.mdx @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostCustomersResetPasswordReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostCustomersResetPasswordReq + +#### Schema + +The customer's email. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostOrderEditsOrderEditDecline.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostOrderEditsOrderEditDecline.mdx new file mode 100644 index 0000000000..ad50f64b31 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostOrderEditsOrderEditDecline.mdx @@ -0,0 +1,31 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostOrderEditsOrderEditDecline + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostOrderEditsOrderEditDecline + +#### Schema + +StorePostOrderEditsOrderEditDecline +type: object +properties: + declined_reason: + type: string + description: The reason for declining the Order Edit. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.mdx new file mode 100644 index 0000000000..13713d5e09 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostPaymentCollectionsBatchSessionsAuthorizeReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostPaymentCollectionsBatchSessionsAuthorizeReq + +#### Schema + +List of Payment Session IDs to authorize. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostPaymentCollectionsBatchSessionsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostPaymentCollectionsBatchSessionsReq.mdx new file mode 100644 index 0000000000..6df6dca397 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostPaymentCollectionsBatchSessionsReq.mdx @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostPaymentCollectionsBatchSessionsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostPaymentCollectionsBatchSessionsReq + +#### Schema + +An array of payment sessions related to the Payment Collection. Existing sessions that are not added in this array will be deleted. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostPaymentCollectionsSessionsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostPaymentCollectionsSessionsReq.mdx new file mode 100644 index 0000000000..8338078e1e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostPaymentCollectionsSessionsReq.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostPaymentCollectionsSessionsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostPaymentCollectionsSessionsReq + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostReturnsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostReturnsReq.mdx new file mode 100644 index 0000000000..430e9c1231 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostReturnsReq.mdx @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostReturnsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostReturnsReq + +#### Schema + +The items to include in the return. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostSearchReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostSearchReq.mdx new file mode 100644 index 0000000000..7cd871285f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostSearchReq.mdx @@ -0,0 +1,63 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostSearchReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostSwapsReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostSwapsReq.mdx new file mode 100644 index 0000000000..ace02c9b7c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StorePostSwapsReq.mdx @@ -0,0 +1,50 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StorePostSwapsReq + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StorePostSwapsReq + +#### Schema + +The items to include in the Return. + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreService.mdx new file mode 100644 index 0000000000..aff5247de0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreService.mdx @@ -0,0 +1,513 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StoreService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StoreService + +Provides layer to manipulate store settings. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currencyRepository_", + "type": "`Repository`<[`Currency`](admin_collections.internal.Currency.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "storeRepository_", + "type": "`Repository`<[`Store`](admin_discounts.internal.internal.Store.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addCurrency + +▸ **addCurrency**(`code`): `Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> + +Add a currency to the store + +#### Parameters + + + +#### Returns + +`Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "result after update", + "children": [ + { + "name": "Store", + "type": "[`Store`](admin_discounts.internal.internal.Store.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(): `Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> + +Creates a store if it doesn't already exist. + +#### Returns + +`Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "The store.", + "children": [ + { + "name": "Store", + "type": "[`Store`](admin_discounts.internal.internal.Store.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getDefaultCurrency\_ + +▸ `Protected` **getDefaultCurrency_**(`code`): [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`Currency`](admin_collections.internal.Currency.mdx)\> + +#### Parameters + + + +#### Returns + +[`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`Currency`](admin_collections.internal.Currency.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Currency", + "type": "[`Currency`](admin_collections.internal.Currency.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeCurrency + +▸ **removeCurrency**(`code`): `Promise`<`any`\> + +Removes a currency from the store + +#### Parameters + + + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "result after update", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`config?`): `Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> + +Retrieve the store settings. There is always a maximum of one store. + +#### Parameters + +", + "description": "The config object from which the query will be built", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the store", + "children": [ + { + "name": "Store", + "type": "[`Store`](admin_discounts.internal.internal.Store.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`data`): `Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> + +Updates a store + +#### Parameters + + + +#### Returns + +`Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the update result.", + "children": [ + { + "name": "Store", + "type": "[`Store`](admin_discounts.internal.internal.Store.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`StoreService`](admin_discounts.internal.internal.StoreService.mdx) + +#### Parameters + + + +#### Returns + +[`StoreService`](admin_discounts.internal.internal.StoreService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StrategyResolverService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StrategyResolverService.mdx new file mode 100644 index 0000000000..5c905243f5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StrategyResolverService.mdx @@ -0,0 +1,274 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StrategyResolverService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).StrategyResolverService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "container", + "type": "[`InjectedDependencies`](../../admin_discounts/modules/admin_discounts.internal.mdx#injecteddependencies-38)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### resolveBatchJobByType + +▸ **resolveBatchJobByType**(`type`): [`AbstractBatchJobStrategy`](admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx) + +#### Parameters + + + +#### Returns + +[`AbstractBatchJobStrategy`](admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx) + + + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`StrategyResolverService`](admin_discounts.internal.internal.StrategyResolverService.mdx) + +#### Parameters + + + +#### Returns + +[`StrategyResolverService`](admin_discounts.internal.internal.StrategyResolverService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SwapService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SwapService.mdx new file mode 100644 index 0000000000..0c2f069cb2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SwapService.mdx @@ -0,0 +1,1381 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SwapService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).SwapService + +Handles swaps + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "cartService_", + "type": "[`CartService`](admin_discounts.internal.internal.CartService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customShippingOptionService_", + "type": "[`CustomShippingOptionService`](admin_discounts.internal.internal.CustomShippingOptionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillmentService_", + "type": "[`FulfillmentService`](admin_discounts.internal.FulfillmentService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemAdjustmentService_", + "type": "[`LineItemAdjustmentService`](admin_discounts.internal.internal.LineItemAdjustmentService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "lineItemService_", + "type": "[`LineItemService`](admin_discounts.internal.internal.LineItemService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orderService_", + "type": "[`OrderService`](admin_discounts.internal.internal.OrderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentProviderService_", + "type": "[`PaymentProviderService`](admin_discounts.internal.internal.PaymentProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productVariantInventoryService_", + "type": "[`ProductVariantInventoryService`](admin_discounts.internal.internal.ProductVariantInventoryService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnService_", + "type": "[`ReturnService`](admin_discounts.internal.internal.ReturnService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingOptionService_", + "type": "[`ShippingOptionService`](admin_discounts.internal.internal.ShippingOptionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swapRepository_", + "type": "`Repository`<[`Swap`](admin_collections.internal.Swap.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "totalsService_", + "type": "[`TotalsService`](admin_discounts.internal.internal.TotalsService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.FULFILLMENT_CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PAYMENT_CAPTURED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PAYMENT_CAPTURE_FAILED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PAYMENT_COMPLETED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PROCESS_REFUND_FAILED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.RECEIVED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.REFUND_PROCESSED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.SHIPMENT_CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### areReturnItemsValid + +▸ `Protected` **areReturnItemsValid**(`returnItems`): `Promise`<`boolean`\> + +#### Parameters + +, ``\"item_id\"``\\>[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### cancel + +▸ **cancel**(`swapId`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the canceled swap.", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +Cancels a fulfillment (if related to a swap) + +#### Parameters + + + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated swap", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### create + +▸ **create**(`order`, `returnItems`, `additionalItems?`, `returnShipping?`, `custom?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +Creates a swap from an order, with given return items, additional items +and an optional return shipping method. + +#### Parameters + +, ``\"item_id\"``\\>[]", + "description": "the items to return in the swap", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additionalItems", + "type": "[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`LineItem`](admin_collections.internal.LineItem.mdx), ``\"variant_id\"`` \\| ``\"quantity\"``\\>[]", + "description": "the items to send to the customer", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returnShipping", + "type": "`object`", + "description": "an optional shipping method for returning the returnItems", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returnShipping.option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnShipping.price", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "custom", + "type": "`object`", + "description": "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", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "custom.allow_backorder", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "custom.idempotency_key", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "custom.location_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "custom.no_notification", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the newly created swap", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createCart + +▸ **createCart**(`swapId`, `customShippingOptions?`, `context?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the swap with its cart_id prop set to the id of the new cart.", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createFulfillment + +▸ **createFulfillment**(`swapId`, `config?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +Fulfills the additional items associated with the swap. Will call the +fulfillment providers associated with the shipping methods. + +#### Parameters + + + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated swap with new status and fulfillments.", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createShipment + +▸ **createShipment**(`swapId`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +Marks a fulfillment as shipped and attaches tracking numbers. + +#### Parameters + + + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the updated swap with new fulfillments and status.", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### deleteMetadata + +▸ **deleteMetadata**(`swapId`, `key`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +Dedicated method to delete metadata for a swap. + +#### Parameters + + + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the updated result.", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)[]\> + +List swaps. + +#### Parameters + +", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Swap`](admin_collections.internal.Swap.mdx)\\>", + "description": "the configuration used to find the objects. contains relations, skip, and take.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "Swap[]", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Swap`](admin_collections.internal.Swap.mdx)[], `number`]\> + +List swaps. + +#### Parameters + +", + "description": "the query object for find", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Swap`](admin_collections.internal.Swap.mdx)\\>", + "description": "the configuration used to find the objects. contains relations, skip, and take.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`Swap`](admin_collections.internal.Swap.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "Swap[]", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### processDifference + +▸ **processDifference**(`swapId`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +Process difference for the requested swap. + +#### Parameters + + + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "processed swap", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### registerCartCompletion + +▸ **registerCartCompletion**(`swapId`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +Register a cart completion + +#### Parameters + + + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "swap related to the cart", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### registerReceived + +▸ **registerReceived**(`id`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +Registers the swap return items as received so that they cannot be used +as a part of other swaps/returns. + +#### Parameters + + + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the resulting order", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`swapId`, `config?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +Retrieves a swap with the given id. + +#### Parameters + +, ``\"select\"``\\> & { `select?`: `string`[] }", + "description": "the configuration to retrieve the swap", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the swap", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByCartId + +▸ **retrieveByCartId**(`cartId`, `relations?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +Retrieves a swap based on its associated cart id + +#### Parameters + + + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the swap", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### transformQueryForCart + +▸ `Protected` **transformQueryForCart**(`config`): [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Swap`](admin_collections.internal.Swap.mdx)\>, ``"select"``\> & { `select?`: `string`[] } & { `cartRelations`: `undefined` \| `string`[] ; `cartSelects`: `undefined` \| keyof [`Cart`](admin_collections.internal.Cart.mdx)[] } + +Transform find config object for retrieval. + +#### Parameters + +, ``\"select\"``\\> & { `select?`: `string`[] }", + "description": "parsed swap find config", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Swap`](admin_collections.internal.Swap.mdx)\>, ``"select"``\> & { `select?`: `string`[] } & { `cartRelations`: `undefined` \| `string`[] ; `cartSelects`: `undefined` \| keyof [`Cart`](admin_collections.internal.Cart.mdx)[] } + +, ``\"select\"``\\> & { `select?`: `string`[] } & { `cartRelations`: `undefined` \\| `string`[] ; `cartSelects`: `undefined` \\| keyof [`Cart`](admin_collections.internal.Cart.mdx)[] }", + "type": "[`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Swap`](admin_collections.internal.Swap.mdx)\\>, ``\"select\"``\\> & { `select?`: `string`[] } & { `cartRelations`: `undefined` \\| `string`[] ; `cartSelects`: `undefined` \\| keyof [`Cart`](admin_collections.internal.Cart.mdx)[] }", + "optional": true, + "defaultValue": "", + "description": "transformed find swap config", + "children": [] + } +]} /> + +___ + +### update + +▸ **update**(`swapId`, `update`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +Update the swap record. + +#### Parameters + +", + "description": "new data", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "updated swap record", + "children": [ + { + "name": "Swap", + "type": "[`Swap`](admin_collections.internal.Swap.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`SwapService`](admin_discounts.internal.internal.SwapService.mdx) + +#### Parameters + + + +#### Returns + +[`SwapService`](admin_discounts.internal.internal.SwapService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SystemPaymentProviderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SystemPaymentProviderService.mdx new file mode 100644 index 0000000000..fbde345acb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SystemPaymentProviderService.mdx @@ -0,0 +1,823 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SystemPaymentProviderService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).SystemPaymentProviderService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "identifier", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### authorizePayment + +▸ **authorizePayment**(`_`): `Promise`\> + +#### Parameters + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### cancelPayment + +▸ **cancelPayment**(`_`): `Promise`\> + +#### Parameters + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### capturePayment + +▸ **capturePayment**(`_`): `Promise`\> + +#### Parameters + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### createPayment + +▸ **createPayment**(`_`): `Promise`\> + +#### Parameters + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### deletePayment + +▸ **deletePayment**(`_`): `Promise`\> + +#### Parameters + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### getPaymentData + +▸ **getPaymentData**(`_`): `Promise`\> + +#### Parameters + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### getStatus + +▸ **getStatus**(`_`): `Promise`<`string`\> + +#### Parameters + + + +#### Returns + +`Promise`<`string`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### refundPayment + +▸ **refundPayment**(`_`): `Promise`\> + +#### Parameters + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### updatePayment + +▸ **updatePayment**(`_`): `Promise`\> + +#### Parameters + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### updatePaymentData + +▸ **updatePaymentData**(`_`): `Promise`\> + +#### Parameters + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`SystemPaymentProviderService`](admin_discounts.internal.internal.SystemPaymentProviderService.mdx) + +#### Parameters + + + +#### Returns + +[`SystemPaymentProviderService`](admin_discounts.internal.internal.SystemPaymentProviderService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxProviderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxProviderService.mdx new file mode 100644 index 0000000000..d2bbc11314 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxProviderService.mdx @@ -0,0 +1,917 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TaxProviderService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).TaxProviderService + +Finds tax providers and assists in tax related operations. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "cacheService_", + "type": "[`ICacheService`](../interfaces/admin_discounts.internal.ICacheService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "container_", + "type": "`AwilixContainer`<`any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`IEventBusService`](../interfaces/admin_discounts.internal.IEventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "getCacheKey", + "type": "`any`", + "description": "The cache key to get cache hits by.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "smTaxLineRepo_", + "type": "`Repository`<[`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx)\\> & { `deleteForCart`: Method deleteForCart ; `upsertLines`: Method upsertLines }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxLineRepo_", + "type": "`Repository`<[`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx)\\> & { `deleteForCart`: Method deleteForCart ; `upsertLines`: Method upsertLines }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxProviderRepo_", + "type": "`Repository`<[`TaxProvider`](admin_collections.internal.TaxProvider.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxRateService_", + "type": "[`TaxRateService`](admin_discounts.internal.internal.TaxRateService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### clearLineItemsTaxLines + +▸ **clearLineItemsTaxLines**(`itemIds`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### clearTaxLines + +▸ **clearTaxLines**(`cartId`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### createShippingTaxLines + +▸ **createShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]\> + +Persists the tax lines relevant for a shipping method to the database. Used +for return shipping methods. + +#### Parameters + + + +#### Returns + +`Promise`<([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the newly created tax lines", + "children": [ + { + "name": "(ShippingMethodTaxLine \\| LineItemTaxLine)[]", + "type": "([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \\| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingMethodTaxLine \\| LineItemTaxLine", + "type": "[`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \\| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### createTaxLines + +▸ **createTaxLines**(`cartOrLineItems`, `calculationContext`): `Promise`<([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]\> + +Persists the tax lines relevant for an order to the database. + +#### Parameters + + + +#### Returns + +`Promise`<([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the newly created tax lines", + "children": [ + { + "name": "(ShippingMethodTaxLine \\| LineItemTaxLine)[]", + "type": "([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \\| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingMethodTaxLine \\| LineItemTaxLine", + "type": "[`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \\| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### getRegionRatesForProduct + +▸ **getRegionRatesForProduct**(`productIds`, `region`): `Promise`<`Map`<`string`, [`TaxServiceRate`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxservicerate)[]\>\> + +Gets the tax rates configured for a product. The rates are cached between +calls. + +#### Parameters + + + +#### Returns + +`Promise`<`Map`<`string`, [`TaxServiceRate`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxservicerate)[]\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "the tax rates configured for the shipping option. A map by product id", + "children": [ + { + "name": "Map", + "type": "`Map`<`string`, [`TaxServiceRate`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxservicerate)[]\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "TaxServiceRate[]", + "type": "[`TaxServiceRate`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxservicerate)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### getRegionRatesForShipping + +▸ **getRegionRatesForShipping**(`optionId`, `regionDetails`): `Promise`<[`TaxServiceRate`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxservicerate)[]\> + +Gets the tax rates configured for a shipping option. The rates are cached +between calls. + +#### Parameters + + + +#### Returns + +`Promise`<[`TaxServiceRate`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxservicerate)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the tax rates configured for the shipping option.", + "children": [ + { + "name": "TaxServiceRate[]", + "type": "[`TaxServiceRate`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxservicerate)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxServiceRate", + "type": "`object`", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### getShippingTaxLines + +▸ **getShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<[`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx)[]\> + +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 + + + +#### Returns + +`Promise`<[`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the computed tax lines", + "children": [ + { + "name": "ShippingMethodTaxLine[]", + "type": "[`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingMethodTaxLine", + "type": "[`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### getTaxLines + +▸ **getTaxLines**(`lineItems`, `calculationContext`): `Promise`<([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]\> + +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 + + + +#### Returns + +`Promise`<([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the computed tax lines", + "children": [ + { + "name": "(ShippingMethodTaxLine \\| LineItemTaxLine)[]", + "type": "([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \\| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingMethodTaxLine \\| LineItemTaxLine", + "type": "[`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \\| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### getTaxLinesMap + +▸ `Protected` **getTaxLinesMap**(`items`, `calculationContext`): `Promise`<[`TaxLinesMaps`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxlinesmaps)\> + +Return a map of tax lines for line items and shipping methods + +#### Parameters + + + +#### Returns + +`Promise`<[`TaxLinesMaps`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxlinesmaps)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxLinesMaps", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(): `Promise`<[`TaxProvider`](admin_collections.internal.TaxProvider.mdx)[]\> + +#### Returns + +`Promise`<[`TaxProvider`](admin_collections.internal.TaxProvider.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxProvider[]", + "type": "[`TaxProvider`](admin_collections.internal.TaxProvider.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxProvider", + "type": "[`TaxProvider`](admin_collections.internal.TaxProvider.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### registerInstalledProviders + +▸ **registerInstalledProviders**(`providers`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### retrieveProvider + +▸ **retrieveProvider**(`region`): [`ITaxService`](../interfaces/admin_discounts.internal.internal.ITaxService.mdx) + +Retrieves the relevant tax provider for the given region. + +#### Parameters + + + +#### Returns + +[`ITaxService`](../interfaces/admin_discounts.internal.internal.ITaxService.mdx) + + `Promise`<[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx) + +#### Parameters + + + +#### Returns + +[`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxRateService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxRateService.mdx new file mode 100644 index 0000000000..0d0719a4b7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxRateService.mdx @@ -0,0 +1,995 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TaxRateService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).TaxRateService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productService_", + "type": "[`ProductService`](admin_discounts.internal.internal.ProductService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productTypeService_", + "type": "[`ProductTypeService`](admin_discounts.internal.internal.ProductTypeService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shippingOptionService_", + "type": "[`ShippingOptionService`](admin_discounts.internal.internal.ShippingOptionService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxRateRepository_", + "type": "`Repository`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)\\> & { `addToProduct`: Method addToProduct ; `addToProductType`: Method addToProductType ; `addToShippingOption`: Method addToShippingOption ; `applyResolutionsToQueryBuilder`: Method applyResolutionsToQueryBuilder ; `findAndCountWithResolution`: Method findAndCountWithResolution ; `findOneWithResolution`: Method findOneWithResolution ; `findWithResolution`: Method findWithResolution ; `getFindQueryBuilder`: Method getFindQueryBuilder ; `listByProduct`: Method listByProduct ; `listByShippingOption`: Method listByShippingOption ; `removeFromProduct`: Method removeFromProduct ; `removeFromProductType`: Method removeFromProductType ; `removeFromShippingOption`: Method removeFromShippingOption }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## Methods + +### addToProduct + +▸ **addToProduct**(`id`, `productIds`, `replace?`): `Promise`<[`ProductTaxRate`](admin_discounts.internal.internal.ProductTaxRate.mdx) \| [`ProductTaxRate`](admin_discounts.internal.internal.ProductTaxRate.mdx)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductTaxRate`](admin_discounts.internal.internal.ProductTaxRate.mdx) \| [`ProductTaxRate`](admin_discounts.internal.internal.ProductTaxRate.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductTaxRate \\| ProductTaxRate[]", + "type": "[`ProductTaxRate`](admin_discounts.internal.internal.ProductTaxRate.mdx) \\| [`ProductTaxRate`](admin_discounts.internal.internal.ProductTaxRate.mdx)[]", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### addToProductType + +▸ **addToProductType**(`id`, `productTypeIds`, `replace?`): `Promise`<[`ProductTypeTaxRate`](admin_discounts.internal.internal.ProductTypeTaxRate.mdx)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ProductTypeTaxRate`](admin_discounts.internal.internal.ProductTypeTaxRate.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductTypeTaxRate[]", + "type": "[`ProductTypeTaxRate`](admin_discounts.internal.internal.ProductTypeTaxRate.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProductTypeTaxRate", + "type": "[`ProductTypeTaxRate`](admin_discounts.internal.internal.ProductTypeTaxRate.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### addToShippingOption + +▸ **addToShippingOption**(`id`, `optionIds`, `replace?`): `Promise`<[`ShippingTaxRate`](admin_discounts.internal.internal.ShippingTaxRate.mdx)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingTaxRate`](admin_discounts.internal.internal.ShippingTaxRate.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingTaxRate[]", + "type": "[`ShippingTaxRate`](admin_discounts.internal.internal.ShippingTaxRate.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ShippingTaxRate", + "type": "[`ShippingTaxRate`](admin_discounts.internal.internal.ShippingTaxRate.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`data`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxRate", + "type": "[`TaxRate`](admin_collections.internal.TaxRate.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`id`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxRate[]", + "type": "[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxRate", + "type": "[`TaxRate`](admin_collections.internal.TaxRate.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`TaxRate`](admin_collections.internal.TaxRate.mdx)[], `number`]\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`TaxRate`](admin_collections.internal.TaxRate.mdx)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxRate[]", + "type": "[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### listByProduct + +▸ **listByProduct**(`productId`, `config`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxRate[]", + "type": "[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxRate", + "type": "[`TaxRate`](admin_collections.internal.TaxRate.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listByShippingOption + +▸ **listByShippingOption**(`shippingOptionId`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxRate[]", + "type": "[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxRate", + "type": "[`TaxRate`](admin_collections.internal.TaxRate.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### removeFromProduct + +▸ **removeFromProduct**(`id`, `productIds`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### removeFromProductType + +▸ **removeFromProductType**(`id`, `typeIds`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### removeFromShippingOption + +▸ **removeFromShippingOption**(`id`, `optionIds`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`taxRateId`, `config?`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxRate", + "type": "[`TaxRate`](admin_collections.internal.TaxRate.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`id`, `data`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "TaxRate", + "type": "[`TaxRate`](admin_collections.internal.TaxRate.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`TaxRateService`](admin_discounts.internal.internal.TaxRateService.mdx) + +#### Parameters + + + +#### Returns + +[`TaxRateService`](admin_discounts.internal.internal.TaxRateService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TokenService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TokenService.mdx new file mode 100644 index 0000000000..6feb6190eb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TokenService.mdx @@ -0,0 +1,114 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TokenService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).TokenService + +## Properties + + + +## Methods + +### signToken + +▸ **signToken**(`data`, `options?`): `string` + +#### Parameters + + + +#### Returns + +`string` + + + +___ + +### verifyToken + +▸ **verifyToken**(`token`, `options?`): `string` \| `Jwt` \| `JwtPayload` + +#### Parameters + + + +#### Returns + +`string` \| `Jwt` \| `JwtPayload` + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TotalsService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TotalsService.mdx new file mode 100644 index 0000000000..c4b03575fa --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TotalsService.mdx @@ -0,0 +1,1488 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TotalsService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).TotalsService + +A service that calculates total and subtotals for orders, carts etc.. + +#### Implements + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "newTotalsService_", + "type": "[`NewTotalsService`](admin_discounts.internal.internal.NewTotalsService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxCalculationStrategy_", + "type": "[`ITaxCalculationStrategy`](../interfaces/admin_discounts.internal.internal.ITaxCalculationStrategy.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "taxProviderService_", + "type": "[`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### calculateDiscount\_ + +▸ **calculateDiscount_**(`lineItem`, `variant`, `variantPrice`, `value`, `discountType`): [`LineDiscount`](../../admin_discounts/modules/admin_discounts.internal.mdx#linediscount) + +Calculates either fixed or percentage discount of a variant + +#### Parameters + + + +#### Returns + +[`LineDiscount`](../../admin_discounts/modules/admin_discounts.internal.mdx#linediscount) + + + +#### Deprecated + +- in favour of DiscountService.calculateDiscountForLineItem + +___ + +### getAllocationItemDiscounts + +▸ **getAllocationItemDiscounts**(`discount`, `cart`): [`LineDiscount`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +[`LineDiscount`](../../admin_discounts/modules/admin_discounts.internal.mdx#linediscount)[] + + + +___ + +### getAllocationMap + +▸ **getAllocationMap**(`orderOrCart`, `options?`): `Promise`<[`LineAllocationsMap`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +`Promise`<[`LineAllocationsMap`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineallocationsmap)\> + +", + "optional": false, + "defaultValue": "", + "description": "the allocation map for the line items in the cart or order.", + "children": [ + { + "name": "LineAllocationsMap", + "type": "`object`", + "description": "A map of line item ids and its corresponding gift card and discount allocations", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### getCalculationContext + +▸ **getCalculationContext**(`calculationContextData`, `options?`): `Promise`<[`TaxCalculationContext`](../modules/admin_discounts.internal.internal.mdx#taxcalculationcontext)\> + +Prepares the calculation context for a tax total calculation. + +#### Parameters + + + +#### Returns + +`Promise`<[`TaxCalculationContext`](../modules/admin_discounts.internal.internal.mdx#taxcalculationcontext)\> + +", + "optional": false, + "defaultValue": "", + "description": "the tax calculation context", + "children": [ + { + "name": "TaxCalculationContext", + "type": "`object`", + "description": "Information relevant to a tax calculation, such as the shipping address where the items are going.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "the total discounts amount", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getGiftCardTotal + +▸ **getGiftCardTotal**(`cartOrOrder`, `opts?`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\> + +Gets the gift card amount on a cart or order. + +#### Parameters + + + +#### Returns + +`Promise`<{ `tax_total`: `number` ; `total`: `number` }\> + +", + "optional": false, + "defaultValue": "", + "description": "the gift card amount applied to the cart or order", + "children": [ + { + "name": "`object`", + "type": "`object`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "the gift card amount applied to the cart or order", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getLineDiscounts + +▸ **getLineDiscounts**(`cartOrOrder`, `discount?`): [`LineDiscountAmount`](../../admin_discounts/modules/admin_discounts.internal.mdx#linediscountamount)[] + +Returns the discount amount allocated to the line items of an order. + +#### Parameters + + + +#### Returns + +[`LineDiscountAmount`](../../admin_discounts/modules/admin_discounts.internal.mdx#linediscountamount)[] + + + +___ + +### getLineItemAdjustmentsTotal + +▸ **getLineItemAdjustmentsTotal**(`cartOrOrder`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +___ + +### getLineItemDiscountAdjustment + +▸ **getLineItemDiscountAdjustment**(`lineItem`, `discount`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +___ + +### getLineItemRefund + +▸ **getLineItemRefund**(`order`, `lineItem`): `Promise`<`number`\> + +The amount that can be refunded for a given line item. + +#### Parameters + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "the line item refund amount.", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "the line item total", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getLineItemTotals + +▸ **getLineItemTotals**(`lineItem`, `cartOrOrder`, `options?`): `Promise`<[`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +`Promise`<[`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals-1)\> + +", + "optional": false, + "defaultValue": "", + "description": "the breakdown of the line item totals", + "children": [ + { + "name": "LineItemTotals", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### getPaidTotal + +▸ **getPaidTotal**(`order`): `number` + +Gets the total payments made on an order + +#### Parameters + + + +#### Returns + +`number` + + + +___ + +### 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 + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "the calculated subtotal", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getRefundedTotal + +▸ **getRefundedTotal**(`order`): `number` + +Gets the total refund amount for an order. + +#### Parameters + + + +#### Returns + +`number` + + + +___ + +### getShippingMethodTotals + +▸ **getShippingMethodTotals**(`shippingMethod`, `cartOrOrder`, `opts?`): `Promise`<[`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals-1)\> + +Gets the totals breakdown for a shipping method. Fetches tax lines if not +already provided. + +#### Parameters + + + +#### Returns + +`Promise`<[`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals-1)\> + +", + "optional": false, + "defaultValue": "", + "description": "An object that breaks down the totals for the shipping method", + "children": [ + { + "name": "ShippingMethodTotals", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### getShippingTotal + +▸ **getShippingTotal**(`cartOrOrder`): `Promise`<`number`\> + +Calculates shipping total + +#### Parameters + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "shipping total", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getSubtotal + +▸ **getSubtotal**(`cartOrOrder`, `opts?`): `Promise`<`number`\> + +Calculates subtotal of a given cart or order. + +#### Parameters + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "the calculated subtotal", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getSwapTotal + +▸ **getSwapTotal**(`order`): `number` + +The total paid for swaps. May be negative in case of negative swap +difference. + +#### Parameters + + + +#### Returns + +`number` + + + +___ + +### getTaxTotal + +▸ **getTaxTotal**(`cartOrOrder`, `forceTaxes?`): `Promise`<``null`` \| `number`\> + +Calculates tax total +Currently based on the Danish tax system + +#### Parameters + + + +#### Returns + +`Promise`<``null`` \| `number`\> + +", + "optional": false, + "defaultValue": "", + "description": "tax total", + "children": [ + { + "name": "``null`` \\| number", + "type": "``null`` \\| `number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getTotal + +▸ **getTotal**(`cartOrOrder`, `options?`): `Promise`<`number`\> + +Calculates total of a given cart or order. + +#### Parameters + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "the calculated subtotal", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### rounded + +▸ **rounded**(`value`): `number` + +Rounds a number using Math.round. + +#### Parameters + + + +#### Returns + +`number` + + + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`TotalsService`](admin_discounts.internal.internal.TotalsService.mdx) + +#### Parameters + + + +#### Returns + +[`TotalsService`](admin_discounts.internal.internal.TotalsService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TransactionBaseService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TransactionBaseService.mdx new file mode 100644 index 0000000000..f016cec6c5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TransactionBaseService.mdx @@ -0,0 +1,216 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TransactionBaseService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).TransactionBaseService + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`TransactionBaseService`](admin_discounts.internal.internal.TransactionBaseService.mdx) + +#### Parameters + + + +#### Returns + +[`TransactionBaseService`](admin_discounts.internal.internal.TransactionBaseService.mdx) + + diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.UserService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.UserService.mdx new file mode 100644 index 0000000000..6246ad612f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.UserService.mdx @@ -0,0 +1,820 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UserService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).UserService + +Provides layer to manipulate users. + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "analyticsConfigService_", + "type": "[`AnalyticsConfigService`](admin_discounts.internal.internal.AnalyticsConfigService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventBus_", + "type": "[`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "featureFlagRouter_", + "type": "[`FlagRouter`](admin_discounts.internal.FlagRouter.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "userRepository_", + "type": "`Repository`<[`User`](admin_auth.internal.User.mdx)\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.CREATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.DELETED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.PASSWORD_RESET", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "Events.UPDATED", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### create + +▸ **create**(`user`, `password`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> + +Creates a user with username being validated. +Fails if email is not a valid format. + +#### Parameters + + + +#### Returns + +`Promise`<[`User`](admin_auth.internal.User.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of create", + "children": [ + { + "name": "User", + "type": "[`User`](admin_auth.internal.User.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`userId`): `Promise`<`void`\> + +Deletes a user from a given user id. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the delete operation.", + "children": [] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`string`\> + +", + "optional": false, + "defaultValue": "", + "description": "the generated JSON web token", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### hashPassword\_ + +▸ **hashPassword_**(`password`): `Promise`<`string`\> + +Hashes a password + +#### Parameters + + + +#### Returns + +`Promise`<`string`\> + +", + "optional": false, + "defaultValue": "", + "description": "hashed password", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`User`](admin_auth.internal.User.mdx)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`User`](admin_auth.internal.User.mdx)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the find operation", + "children": [ + { + "name": "User[]", + "type": "[`User`](admin_auth.internal.User.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "User", + "type": "[`User`](admin_auth.internal.User.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`userId`, `config?`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> + +Gets a user by id. +Throws in case of DB Error and if user was not found. + +#### Parameters + +", + "description": "query configs", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`User`](admin_auth.internal.User.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the user document.", + "children": [ + { + "name": "User", + "type": "[`User`](admin_auth.internal.User.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByApiToken + +▸ **retrieveByApiToken**(`apiToken`, `relations?`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> + +Gets a user by api token. +Throws in case of DB Error and if user was not found. + +#### Parameters + + + +#### Returns + +`Promise`<[`User`](admin_auth.internal.User.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the user document.", + "children": [ + { + "name": "User", + "type": "[`User`](admin_auth.internal.User.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveByEmail + +▸ **retrieveByEmail**(`email`, `config?`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> + +Gets a user by email. +Throws in case of DB Error and if user was not found. + +#### Parameters + +", + "description": "query config", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`User`](admin_auth.internal.User.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the user document.", + "children": [ + { + "name": "User", + "type": "[`User`](admin_auth.internal.User.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### setPassword\_ + +▸ **setPassword_**(`userId`, `password`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> + +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 + + + +#### Returns + +`Promise`<[`User`](admin_auth.internal.User.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the update operation", + "children": [ + { + "name": "User", + "type": "[`User`](admin_auth.internal.User.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### update + +▸ **update**(`userId`, `update`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> + +Updates a user. + +#### Parameters + + + +#### Returns + +`Promise`<[`User`](admin_auth.internal.User.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of create", + "children": [ + { + "name": "User", + "type": "[`User`](admin_auth.internal.User.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`UserService`](admin_discounts.internal.internal.UserService.mdx) + +#### Parameters + + + +#### Returns + +[`UserService`](admin_discounts.internal.internal.UserService.mdx) + + + +#### Inherited from + +[TransactionBaseService](admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/classes/swaps.internal.Axios.mdx b/www/apps/docs/content/references/js-client/internal/classes/swaps.internal.Axios.mdx new file mode 100644 index 0000000000..ffde818171 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/swaps.internal.Axios.mdx @@ -0,0 +1,648 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Axios + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).Axios + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "interceptors", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "interceptors.request", + "type": "[`AxiosInterceptorManager`](../interfaces/swaps.internal.AxiosInterceptorManager.mdx)<`AxiosRequestConfig`<`any`\\>\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "interceptors.response", + "type": "[`AxiosInterceptorManager`](../interfaces/swaps.internal.AxiosInterceptorManager.mdx)<[`AxiosResponse`](../interfaces/swaps.internal.AxiosResponse.mdx)<`any`, `any`\\>\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### delete + +▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### get + +▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### getUri + +▸ **getUri**(`config?`): `string` + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`string` + + + +___ + +### head + +▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### options + +▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### patch + +▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### post + +▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### put + +▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### request + +▸ **request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/classes/swaps.internal.Client.mdx b/www/apps/docs/content/references/js-client/internal/classes/swaps.internal.Client.mdx new file mode 100644 index 0000000000..3eef94e189 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/classes/swaps.internal.Client.mdx @@ -0,0 +1,383 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Client + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).Client + +## Properties + + + +## Methods + +### createClient + +▸ **createClient**(`config`): [`AxiosInstance`](../interfaces/swaps.internal.AxiosInstance.mdx) + +Creates the axios client used for requests +As part of the creation, we configure the retry conditions +and the exponential backoff approach. + +#### Parameters + + + +#### Returns + +[`AxiosInstance`](../interfaces/swaps.internal.AxiosInstance.mdx) + + + +___ + +### normalizeHeader + +▸ **normalizeHeader**(`header`): `string` + +#### Parameters + + + +#### Returns + +`string` + + + +___ + +### normalizeHeaders + +▸ **normalizeHeaders**(`obj`): Record<`string`, `any`\> + +#### Parameters + + + +#### Returns + +Record<`string`, `any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### request + +▸ **request**(`method`, `path`, `payload?`, `options?`, `customHeaders?`): `Promise`<`any`\> + +Axios request + +#### Parameters + +", + "description": "request payload", + "optional": false, + "defaultValue": "`{}`", + "children": [] + }, + { + "name": "options", + "type": "[`RequestOptions`](../interfaces/admin_custom.internal.RequestOptions.mdx)", + "description": "axios configuration", + "optional": false, + "defaultValue": "`{}`", + "children": [] + }, + { + "name": "customHeaders", + "type": "Record<`string`, `any`\\>", + "description": "custom request headers", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### requiresAuthentication + +▸ **requiresAuthentication**(`path`, `method`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### setHeaders + +▸ **setHeaders**(`userHeaders`, `method`, `path`, `customHeaders?`): [`AxiosRequestHeaders`](../../swaps/modules/swaps.internal.mdx#axiosrequestheaders) + +Creates all the initial headers. +We add the idempotency key, if the request is configured to retry. + +#### Parameters + +", + "description": "user supplied headers", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`AxiosRequestHeaders`](../../swaps/modules/swaps.internal.mdx#axiosrequestheaders) + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### shouldRetryCondition + +▸ **shouldRetryCondition**(`err`, `numRetries`, `maxRetries`): `boolean` + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "numRetries", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "maxRetries", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_auth.internal.UserRoles.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_auth.internal.UserRoles.mdx new file mode 100644 index 0000000000..8ba2b0d264 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_auth.internal.UserRoles.mdx @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UserRoles + +[admin/auth](../../modules/admin_auth.mdx).[internal](../../admin_auth/modules/admin_auth.internal.mdx).UserRoles + +## Enumeration Members + +### ADMIN + +• **ADMIN** = ``"admin"`` + +___ + +### DEVELOPER + +• **DEVELOPER** = ``"developer"`` + +___ + +### MEMBER + +• **MEMBER** = ``"member"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_batch_jobs.internal.BatchJobStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_batch_jobs.internal.BatchJobStatus.mdx new file mode 100644 index 0000000000..f45167a2b9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_batch_jobs.internal.BatchJobStatus.mdx @@ -0,0 +1,51 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# BatchJobStatus + +[admin/batch-jobs](../../modules/admin_batch_jobs.mdx).[internal](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx).BatchJobStatus + +## Enumeration Members + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +___ + +### COMPLETED + +• **COMPLETED** = ``"completed"`` + +___ + +### CONFIRMED + +• **CONFIRMED** = ``"confirmed"`` + +___ + +### CREATED + +• **CREATED** = ``"created"`` + +___ + +### FAILED + +• **FAILED** = ``"failed"`` + +___ + +### PRE\_PROCESSED + +• **PRE\_PROCESSED** = ``"pre_processed"`` + +___ + +### PROCESSING + +• **PROCESSING** = ``"processing"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.AllocationType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.AllocationType.mdx new file mode 100644 index 0000000000..7b53c32332 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.AllocationType.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AllocationType + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).AllocationType + +## Enumeration Members + +### ITEM + +• **ITEM** = ``"item"`` + +___ + +### TOTAL + +• **TOTAL** = ``"total"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.CartType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.CartType.mdx new file mode 100644 index 0000000000..cf2fee2032 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.CartType.mdx @@ -0,0 +1,39 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CartType + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).CartType + +## Enumeration Members + +### CLAIM + +• **CLAIM** = ``"claim"`` + +___ + +### DEFAULT + +• **DEFAULT** = ``"default"`` + +___ + +### DRAFT\_ORDER + +• **DRAFT\_ORDER** = ``"draft_order"`` + +___ + +### PAYMENT\_LINK + +• **PAYMENT\_LINK** = ``"payment_link"`` + +___ + +### SWAP + +• **SWAP** = ``"swap"`` diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.FulfillmentStatus.md b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimFulfillmentStatus.mdx similarity index 52% rename from www/apps/docs/content/references/js-client/enums/internal-3.FulfillmentStatus.md rename to www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimFulfillmentStatus.mdx index 3b00060c1f..a51c7924fc 100644 --- a/www/apps/docs/content/references/js-client/enums/internal-3.FulfillmentStatus.md +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimFulfillmentStatus.mdx @@ -2,9 +2,11 @@ displayed_sidebar: jsClientSidebar --- -# Enumeration: FulfillmentStatus +import ParameterTypes from "@site/src/components/ParameterTypes" -[internal](../modules/internal-3.md).FulfillmentStatus +# ClaimFulfillmentStatus + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ClaimFulfillmentStatus ## Enumeration Members @@ -12,86 +14,50 @@ displayed_sidebar: jsClientSidebar • **CANCELED** = ``"canceled"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:36 - ___ ### FULFILLED • **FULFILLED** = ``"fulfilled"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:31 - ___ ### NOT\_FULFILLED • **NOT\_FULFILLED** = ``"not_fulfilled"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:29 - ___ ### PARTIALLY\_FULFILLED • **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:30 - ___ ### PARTIALLY\_RETURNED • **PARTIALLY\_RETURNED** = ``"partially_returned"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:34 - ___ ### PARTIALLY\_SHIPPED • **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:32 - ___ ### REQUIRES\_ACTION • **REQUIRES\_ACTION** = ``"requires_action"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:37 - ___ ### RETURNED • **RETURNED** = ``"returned"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:35 - ___ ### SHIPPED • **SHIPPED** = ``"shipped"`` - -#### Defined in - -packages/medusa/dist/models/order.d.ts:33 diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimPaymentStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimPaymentStatus.mdx new file mode 100644 index 0000000000..1a4272ce06 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimPaymentStatus.mdx @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimPaymentStatus + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ClaimPaymentStatus + +## Enumeration Members + +### NA + +• **NA** = ``"na"`` + +___ + +### NOT\_REFUNDED + +• **NOT\_REFUNDED** = ``"not_refunded"`` + +___ + +### REFUNDED + +• **REFUNDED** = ``"refunded"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimReason.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimReason.mdx new file mode 100644 index 0000000000..1255f55d6b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimReason.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimReason + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ClaimReason + +## Enumeration Members + +### MISSING\_ITEM + +• **MISSING\_ITEM** = ``"missing_item"`` + +___ + +### OTHER + +• **OTHER** = ``"other"`` + +___ + +### PRODUCTION\_FAILURE + +• **PRODUCTION\_FAILURE** = ``"production_failure"`` + +___ + +### WRONG\_ITEM + +• **WRONG\_ITEM** = ``"wrong_item"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimType.mdx new file mode 100644 index 0000000000..1fc85322f1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimType.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimType + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ClaimType + +## Enumeration Members + +### REFUND + +• **REFUND** = ``"refund"`` + +___ + +### REPLACE + +• **REPLACE** = ``"replace"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionOperator.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionOperator.mdx new file mode 100644 index 0000000000..bf14bd7e30 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionOperator.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionOperator + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).DiscountConditionOperator + +## Enumeration Members + +### IN + +• **IN** = ``"in"`` + +___ + +### NOT\_IN + +• **NOT\_IN** = ``"not_in"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionType.mdx new file mode 100644 index 0000000000..c058fbe18b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionType.mdx @@ -0,0 +1,39 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionType + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).DiscountConditionType + +## Enumeration Members + +### CUSTOMER\_GROUPS + +• **CUSTOMER\_GROUPS** = ``"customer_groups"`` + +___ + +### PRODUCTS + +• **PRODUCTS** = ``"products"`` + +___ + +### PRODUCT\_COLLECTIONS + +• **PRODUCT\_COLLECTIONS** = ``"product_collections"`` + +___ + +### PRODUCT\_TAGS + +• **PRODUCT\_TAGS** = ``"product_tags"`` + +___ + +### PRODUCT\_TYPES + +• **PRODUCT\_TYPES** = ``"product_types"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountRuleType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountRuleType.mdx new file mode 100644 index 0000000000..720e8a0839 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountRuleType.mdx @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountRuleType + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).DiscountRuleType + +## Enumeration Members + +### FIXED + +• **FIXED** = ``"fixed"`` + +___ + +### FREE\_SHIPPING + +• **FREE\_SHIPPING** = ``"free_shipping"`` + +___ + +### PERCENTAGE + +• **PERCENTAGE** = ``"percentage"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DraftOrderStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DraftOrderStatus.mdx new file mode 100644 index 0000000000..76a49e6a9e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DraftOrderStatus.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DraftOrderStatus + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).DraftOrderStatus + +## Enumeration Members + +### COMPLETED + +• **COMPLETED** = ``"completed"`` + +___ + +### OPEN + +• **OPEN** = ``"open"`` diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.SwapFulfillmentStatus.md b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.FulfillmentStatus.mdx similarity index 50% rename from www/apps/docs/content/references/js-client/enums/internal-3.SwapFulfillmentStatus.md rename to www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.FulfillmentStatus.mdx index 3efec69e7d..2132408549 100644 --- a/www/apps/docs/content/references/js-client/enums/internal-3.SwapFulfillmentStatus.md +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.FulfillmentStatus.mdx @@ -2,9 +2,11 @@ displayed_sidebar: jsClientSidebar --- -# Enumeration: SwapFulfillmentStatus +import ParameterTypes from "@site/src/components/ParameterTypes" -[internal](../modules/internal-3.md).SwapFulfillmentStatus +# FulfillmentStatus + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).FulfillmentStatus ## Enumeration Members @@ -12,29 +14,29 @@ displayed_sidebar: jsClientSidebar • **CANCELED** = ``"canceled"`` -#### Defined in - -packages/medusa/dist/models/swap.d.ts:15 - ___ ### FULFILLED • **FULFILLED** = ``"fulfilled"`` -#### Defined in - -packages/medusa/dist/models/swap.d.ts:12 - ___ ### NOT\_FULFILLED • **NOT\_FULFILLED** = ``"not_fulfilled"`` -#### Defined in +___ -packages/medusa/dist/models/swap.d.ts:11 +### PARTIALLY\_FULFILLED + +• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` + +___ + +### PARTIALLY\_RETURNED + +• **PARTIALLY\_RETURNED** = ``"partially_returned"`` ___ @@ -42,26 +44,20 @@ ___ • **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` -#### Defined in - -packages/medusa/dist/models/swap.d.ts:14 - ___ ### REQUIRES\_ACTION • **REQUIRES\_ACTION** = ``"requires_action"`` -#### Defined in +___ -packages/medusa/dist/models/swap.d.ts:16 +### RETURNED + +• **RETURNED** = ``"returned"`` ___ ### SHIPPED • **SHIPPED** = ``"shipped"`` - -#### Defined in - -packages/medusa/dist/models/swap.d.ts:13 diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditItemChangeType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditItemChangeType.mdx new file mode 100644 index 0000000000..9374735b36 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditItemChangeType.mdx @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderEditItemChangeType + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).OrderEditItemChangeType + +## Enumeration Members + +### ITEM\_ADD + +• **ITEM\_ADD** = ``"item_add"`` + +___ + +### ITEM\_REMOVE + +• **ITEM\_REMOVE** = ``"item_remove"`` + +___ + +### ITEM\_UPDATE + +• **ITEM\_UPDATE** = ``"item_update"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditStatus.mdx new file mode 100644 index 0000000000..36d458aeb6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditStatus.mdx @@ -0,0 +1,39 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderEditStatus + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).OrderEditStatus + +## Enumeration Members + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +___ + +### CONFIRMED + +• **CONFIRMED** = ``"confirmed"`` + +___ + +### CREATED + +• **CREATED** = ``"created"`` + +___ + +### DECLINED + +• **DECLINED** = ``"declined"`` + +___ + +### REQUESTED + +• **REQUESTED** = ``"requested"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderStatus.mdx new file mode 100644 index 0000000000..ac05f8d859 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderStatus.mdx @@ -0,0 +1,39 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderStatus + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).OrderStatus + +## Enumeration Members + +### ARCHIVED + +• **ARCHIVED** = ``"archived"`` + +___ + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +___ + +### COMPLETED + +• **COMPLETED** = ``"completed"`` + +___ + +### PENDING + +• **PENDING** = ``"pending"`` + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = ``"requires_action"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentCollectionStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentCollectionStatus.mdx new file mode 100644 index 0000000000..595c1c6f51 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentCollectionStatus.mdx @@ -0,0 +1,39 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentCollectionStatus + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).PaymentCollectionStatus + +## Enumeration Members + +### AUTHORIZED + +• **AUTHORIZED** = ``"authorized"`` + +___ + +### AWAITING + +• **AWAITING** = ``"awaiting"`` + +___ + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +___ + +### NOT\_PAID + +• **NOT\_PAID** = ``"not_paid"`` + +___ + +### PARTIALLY\_AUTHORIZED + +• **PARTIALLY\_AUTHORIZED** = ``"partially_authorized"`` diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.PaymentStatus.md b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentStatus.mdx similarity index 50% rename from www/apps/docs/content/references/js-client/enums/internal-3.PaymentStatus.md rename to www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentStatus.mdx index f078130c87..26a93bf567 100644 --- a/www/apps/docs/content/references/js-client/enums/internal-3.PaymentStatus.md +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentStatus.mdx @@ -2,9 +2,11 @@ displayed_sidebar: jsClientSidebar --- -# Enumeration: PaymentStatus +import ParameterTypes from "@site/src/components/ParameterTypes" -[internal](../modules/internal-3.md).PaymentStatus +# PaymentStatus + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).PaymentStatus ## Enumeration Members @@ -12,66 +14,38 @@ displayed_sidebar: jsClientSidebar • **AWAITING** = ``"awaiting"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:41 - ___ ### CANCELED • **CANCELED** = ``"canceled"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:45 - ___ ### CAPTURED • **CAPTURED** = ``"captured"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:42 - ___ ### NOT\_PAID • **NOT\_PAID** = ``"not_paid"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:40 - ___ ### PARTIALLY\_REFUNDED • **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:43 - ___ ### REFUNDED • **REFUNDED** = ``"refunded"`` -#### Defined in - -packages/medusa/dist/models/order.d.ts:44 - ___ ### REQUIRES\_ACTION • **REQUIRES\_ACTION** = ``"requires_action"`` - -#### Defined in - -packages/medusa/dist/models/order.d.ts:46 diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListStatus.mdx new file mode 100644 index 0000000000..c166c703e4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListStatus.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListStatus + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).PriceListStatus + +## Enumeration Members + +### ACTIVE + +• **ACTIVE** = ``"active"`` + +___ + +### DRAFT + +• **DRAFT** = ``"draft"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListType.mdx new file mode 100644 index 0000000000..65b44d3243 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListType.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListType + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).PriceListType + +## Enumeration Members + +### OVERRIDE + +• **OVERRIDE** = ``"override"`` + +___ + +### SALE + +• **SALE** = ``"sale"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ProductStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ProductStatus.mdx new file mode 100644 index 0000000000..77ecd60970 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ProductStatus.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductStatus + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ProductStatus + +## Enumeration Members + +### DRAFT + +• **DRAFT** = ``"draft"`` + +___ + +### PROPOSED + +• **PROPOSED** = ``"proposed"`` + +___ + +### PUBLISHED + +• **PUBLISHED** = ``"published"`` + +___ + +### REJECTED + +• **REJECTED** = ``"rejected"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.RequirementType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.RequirementType.mdx new file mode 100644 index 0000000000..e121684dac --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.RequirementType.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RequirementType + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).RequirementType + +## Enumeration Members + +### MAX\_SUBTOTAL + +• **MAX\_SUBTOTAL** = ``"max_subtotal"`` + +___ + +### MIN\_SUBTOTAL + +• **MIN\_SUBTOTAL** = ``"min_subtotal"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ReturnStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ReturnStatus.mdx new file mode 100644 index 0000000000..4d9d34d6a5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ReturnStatus.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnStatus + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ReturnStatus + +## Enumeration Members + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +___ + +### RECEIVED + +• **RECEIVED** = ``"received"`` + +___ + +### REQUESTED + +• **REQUESTED** = ``"requested"`` + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = ``"requires_action"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingOptionPriceType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingOptionPriceType.mdx new file mode 100644 index 0000000000..f9dfff871d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingOptionPriceType.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingOptionPriceType + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ShippingOptionPriceType + +## Enumeration Members + +### CALCULATED + +• **CALCULATED** = ``"calculated"`` + +___ + +### FLAT\_RATE + +• **FLAT\_RATE** = ``"flat_rate"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingProfileType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingProfileType.mdx new file mode 100644 index 0000000000..23120e3342 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingProfileType.mdx @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingProfileType + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ShippingProfileType + +## Enumeration Members + +### CUSTOM + +• **CUSTOM** = ``"custom"`` + +___ + +### DEFAULT + +• **DEFAULT** = ``"default"`` + +___ + +### GIFT\_CARD + +• **GIFT\_CARD** = ``"gift_card"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapFulfillmentStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapFulfillmentStatus.mdx new file mode 100644 index 0000000000..90066dbb9f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapFulfillmentStatus.mdx @@ -0,0 +1,45 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SwapFulfillmentStatus + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).SwapFulfillmentStatus + +## Enumeration Members + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +___ + +### FULFILLED + +• **FULFILLED** = ``"fulfilled"`` + +___ + +### NOT\_FULFILLED + +• **NOT\_FULFILLED** = ``"not_fulfilled"`` + +___ + +### PARTIALLY\_SHIPPED + +• **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = ``"requires_action"`` + +___ + +### SHIPPED + +• **SHIPPED** = ``"shipped"`` diff --git a/www/apps/docs/content/references/js-client/enums/internal-3.SwapPaymentStatus.md b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapPaymentStatus.mdx similarity index 51% rename from www/apps/docs/content/references/js-client/enums/internal-3.SwapPaymentStatus.md rename to www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapPaymentStatus.mdx index 1846f66ddb..8f5cb59ed0 100644 --- a/www/apps/docs/content/references/js-client/enums/internal-3.SwapPaymentStatus.md +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapPaymentStatus.mdx @@ -2,9 +2,11 @@ displayed_sidebar: jsClientSidebar --- -# Enumeration: SwapPaymentStatus +import ParameterTypes from "@site/src/components/ParameterTypes" -[internal](../modules/internal-3.md).SwapPaymentStatus +# SwapPaymentStatus + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).SwapPaymentStatus ## Enumeration Members @@ -12,86 +14,50 @@ displayed_sidebar: jsClientSidebar • **AWAITING** = ``"awaiting"`` -#### Defined in - -packages/medusa/dist/models/swap.d.ts:20 - ___ ### CANCELED • **CANCELED** = ``"canceled"`` -#### Defined in - -packages/medusa/dist/models/swap.d.ts:23 - ___ ### CAPTURED • **CAPTURED** = ``"captured"`` -#### Defined in - -packages/medusa/dist/models/swap.d.ts:21 - ___ ### CONFIRMED • **CONFIRMED** = ``"confirmed"`` -#### Defined in - -packages/medusa/dist/models/swap.d.ts:22 - ___ ### DIFFERENCE\_REFUNDED • **DIFFERENCE\_REFUNDED** = ``"difference_refunded"`` -#### Defined in - -packages/medusa/dist/models/swap.d.ts:24 - ___ ### NOT\_PAID • **NOT\_PAID** = ``"not_paid"`` -#### Defined in - -packages/medusa/dist/models/swap.d.ts:19 - ___ ### PARTIALLY\_REFUNDED • **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` -#### Defined in - -packages/medusa/dist/models/swap.d.ts:25 - ___ ### REFUNDED • **REFUNDED** = ``"refunded"`` -#### Defined in - -packages/medusa/dist/models/swap.d.ts:26 - ___ ### REQUIRES\_ACTION • **REQUIRES\_ACTION** = ``"requires_action"`` - -#### Defined in - -packages/medusa/dist/models/swap.d.ts:27 diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.DefaultPriceType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.DefaultPriceType.mdx new file mode 100644 index 0000000000..778c1fa7c2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.DefaultPriceType.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DefaultPriceType + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).DefaultPriceType + +## References + +### DEFAULT + +Re-exports [DEFAULT](../../admin_discounts/modules/admin_discounts.internal.mdx#default) diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.DiscountConditionJoinTableForeignKey.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.DiscountConditionJoinTableForeignKey.mdx new file mode 100644 index 0000000000..28d3e15684 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.DiscountConditionJoinTableForeignKey.mdx @@ -0,0 +1,39 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionJoinTableForeignKey + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).DiscountConditionJoinTableForeignKey + +## Enumeration Members + +### CUSTOMER\_GROUP\_ID + +• **CUSTOMER\_GROUP\_ID** = ``"customer_group_id"`` + +___ + +### PRODUCT\_COLLECTION\_ID + +• **PRODUCT\_COLLECTION\_ID** = ``"product_collection_id"`` + +___ + +### PRODUCT\_ID + +• **PRODUCT\_ID** = ``"product_id"`` + +___ + +### PRODUCT\_TAG\_ID + +• **PRODUCT\_TAG\_ID** = ``"product_tag_id"`` + +___ + +### PRODUCT\_TYPE\_ID + +• **PRODUCT\_TYPE\_ID** = ``"product_type_id"`` diff --git a/www/apps/docs/content/references/js-client/enums/internal-8.FulfillmentStatus.md b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.FulfillmentStatus.mdx similarity index 52% rename from www/apps/docs/content/references/js-client/enums/internal-8.FulfillmentStatus.md rename to www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.FulfillmentStatus.mdx index ce3b64a280..b92735b141 100644 --- a/www/apps/docs/content/references/js-client/enums/internal-8.FulfillmentStatus.md +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.FulfillmentStatus.mdx @@ -2,9 +2,11 @@ displayed_sidebar: jsClientSidebar --- -# Enumeration: FulfillmentStatus +import ParameterTypes from "@site/src/components/ParameterTypes" -[internal](../modules/internal-8.md).FulfillmentStatus +# FulfillmentStatus + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).FulfillmentStatus ## Enumeration Members @@ -12,86 +14,50 @@ displayed_sidebar: jsClientSidebar • **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/internal/enums/admin_discounts.internal.MODULE_RESOURCE_TYPE.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.MODULE_RESOURCE_TYPE.mdx new file mode 100644 index 0000000000..1fc22331d9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.MODULE_RESOURCE_TYPE.mdx @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# MODULE\_RESOURCE\_TYPE + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).MODULE_RESOURCE_TYPE + +## Enumeration Members + +### ISOLATED + +• **ISOLATED** = ``"isolated"`` + +___ + +### SHARED + +• **SHARED** = ``"shared"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.OrderStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.OrderStatus.mdx new file mode 100644 index 0000000000..6a2333f044 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.OrderStatus.mdx @@ -0,0 +1,39 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderStatus + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).OrderStatus + +## Enumeration Members + +### archived + +• **archived** = ``"archived"`` + +___ + +### canceled + +• **canceled** = ``"canceled"`` + +___ + +### completed + +• **completed** = ``"completed"`` + +___ + +### pending + +• **pending** = ``"pending"`` + +___ + +### requires\_action + +• **requires\_action** = ``"requires_action"`` diff --git a/www/apps/docs/content/references/js-client/enums/internal-8.PaymentStatus.md b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.PaymentStatus.mdx similarity index 50% rename from www/apps/docs/content/references/js-client/enums/internal-8.PaymentStatus.md rename to www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.PaymentStatus.mdx index 9a2afd70a8..ce3f73be34 100644 --- a/www/apps/docs/content/references/js-client/enums/internal-8.PaymentStatus.md +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.PaymentStatus.mdx @@ -2,9 +2,11 @@ displayed_sidebar: jsClientSidebar --- -# Enumeration: PaymentStatus +import ParameterTypes from "@site/src/components/ParameterTypes" -[internal](../modules/internal-8.md).PaymentStatus +# PaymentStatus + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).PaymentStatus ## Enumeration Members @@ -12,66 +14,38 @@ displayed_sidebar: jsClientSidebar • **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/internal/enums/admin_discounts.internal.internal.PaymentCollectionType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PaymentCollectionType.mdx new file mode 100644 index 0000000000..91d5906f22 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PaymentCollectionType.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentCollectionType + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).PaymentCollectionType + +## References + +### ORDER\_EDIT + +Re-exports [ORDER_EDIT](../../admin_collections/modules/admin_collections.internal.mdx#order_edit) diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx new file mode 100644 index 0000000000..780775061b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx @@ -0,0 +1,39 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentSessionStatus + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).PaymentSessionStatus + +## Enumeration Members + +### AUTHORIZED + +• **AUTHORIZED** = ``"authorized"`` + +___ + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +___ + +### ERROR + +• **ERROR** = ``"error"`` + +___ + +### PENDING + +• **PENDING** = ``"pending"`` + +___ + +### REQUIRES\_MORE + +• **REQUIRES\_MORE** = ``"requires_more"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PostgresError.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PostgresError.mdx new file mode 100644 index 0000000000..b8f82b9b5d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PostgresError.mdx @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PostgresError + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).PostgresError + +## Enumeration Members + +### DUPLICATE\_ERROR + +• **DUPLICATE\_ERROR** = ``"23505"`` + +___ + +### FOREIGN\_KEY\_ERROR + +• **FOREIGN\_KEY\_ERROR** = ``"23503"`` + +___ + +### NULL\_VIOLATION + +• **NULL\_VIOLATION** = ``"23502"`` + +___ + +### SERIALIZATION\_FAILURE + +• **SERIALIZATION\_FAILURE** = ``"40001"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.RefundReason.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.RefundReason.mdx new file mode 100644 index 0000000000..820c745203 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.RefundReason.mdx @@ -0,0 +1,39 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RefundReason + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).RefundReason + +## Enumeration Members + +### CLAIM + +• **CLAIM** = ``"claim"`` + +___ + +### DISCOUNT + +• **DISCOUNT** = ``"discount"`` + +___ + +### OTHER + +• **OTHER** = ``"other"`` + +___ + +### RETURN + +• **RETURN** = ``"return"`` + +___ + +### SWAP + +• **SWAP** = ``"swap"`` diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_collections.internal.Boolean.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_collections.internal.Boolean.mdx new file mode 100644 index 0000000000..323d8dccf0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_collections.internal.Boolean.mdx @@ -0,0 +1,32 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Boolean + +[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).Boolean + +## Methods + +### valueOf + +▸ **valueOf**(): `boolean` + +Returns the primitive value of the specified object. + +#### Returns + +`boolean` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_custom.internal.RequestOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_custom.internal.RequestOptions.mdx new file mode 100644 index 0000000000..30eb9acbbb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_custom.internal.RequestOptions.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RequestOptions + +[admin/custom](../../modules/admin_custom.mdx).[internal](../../admin_custom/modules/admin_custom.internal.mdx).RequestOptions + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ArrayBufferView.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ArrayBufferView.mdx new file mode 100644 index 0000000000..c348f8ebe8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ArrayBufferView.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ArrayBufferView + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ArrayBufferView + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ArrayLike.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ArrayLike.mdx new file mode 100644 index 0000000000..6c7764f3c1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ArrayLike.mdx @@ -0,0 +1,39 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ArrayLike + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ArrayLike + +## Type parameters + + + +## Indexable + +▪ [n: `number`]: `T` + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGenerator.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGenerator.mdx new file mode 100644 index 0000000000..e34796f6b4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGenerator.mdx @@ -0,0 +1,200 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AsyncGenerator + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AsyncGenerator + +## Type parameters + + + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncGenerator`](admin_discounts.internal.AsyncGenerator.mdx)<`T`, `TReturn`, `TNext`\> + +#### Returns + +[`AsyncGenerator`](admin_discounts.internal.AsyncGenerator.mdx)<`T`, `TReturn`, `TNext`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### next + +▸ **next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> + +#### Parameters + + + +#### Returns + +`Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "IteratorResult", + "type": "[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Overrides + +[AsyncIterator](admin_discounts.internal.AsyncIterator.mdx).[next](admin_discounts.internal.AsyncIterator.mdx#next) + +___ + +### return + +▸ **return**(`value`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "IteratorResult", + "type": "[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Overrides + +[AsyncIterator](admin_discounts.internal.AsyncIterator.mdx).[return](admin_discounts.internal.AsyncIterator.mdx#return) + +___ + +### throw + +▸ **throw**(`e`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> + +#### Parameters + + + +#### Returns + +`Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "IteratorResult", + "type": "[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Overrides + +[AsyncIterator](admin_discounts.internal.AsyncIterator.mdx).[throw](admin_discounts.internal.AsyncIterator.mdx#throw) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx new file mode 100644 index 0000000000..21663e1fdf --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx @@ -0,0 +1,99 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AsyncGeneratorFunction + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AsyncGeneratorFunction + +## Callable + +### AsyncGeneratorFunction + +▸ **AsyncGeneratorFunction**(`...args`): [`AsyncGenerator`](admin_discounts.internal.AsyncGenerator.mdx)<`unknown`, `any`, `unknown`\> + +Creates a new AsyncGenerator object. + +#### Parameters + + + +#### Returns + +[`AsyncGenerator`](admin_discounts.internal.AsyncGenerator.mdx)<`unknown`, `any`, `unknown`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +## Properties + +", + "description": "A reference to the prototype.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterable.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterable.mdx new file mode 100644 index 0000000000..692df65fac --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterable.mdx @@ -0,0 +1,60 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AsyncIterable + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AsyncIterable + +## Type parameters + + + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterator`](admin_discounts.internal.AsyncIterator.mdx)<`T`, `any`, `undefined`\> + +#### Returns + +[`AsyncIterator`](admin_discounts.internal.AsyncIterator.mdx)<`T`, `any`, `undefined`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "undefined", + "type": "`undefined`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx new file mode 100644 index 0000000000..38ade018d2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx @@ -0,0 +1,211 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AsyncIterableIterator + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AsyncIterableIterator + +## Type parameters + + + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`T`\> + +#### Returns + +[`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`T`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### next + +▸ **next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\> + +#### Parameters + + + +#### Returns + +`Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "IteratorResult", + "type": "[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +[AsyncIterator](admin_discounts.internal.AsyncIterator.mdx).[next](admin_discounts.internal.AsyncIterator.mdx#next) + +___ + +### return + +▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\> + +#### Parameters + + + +#### Returns + +`Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "IteratorResult", + "type": "[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +[AsyncIterator](admin_discounts.internal.AsyncIterator.mdx).[return](admin_discounts.internal.AsyncIterator.mdx#return) + +___ + +### throw + +▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\> + +#### Parameters + + + +#### Returns + +`Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "IteratorResult", + "type": "[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +[AsyncIterator](admin_discounts.internal.AsyncIterator.mdx).[throw](admin_discounts.internal.AsyncIterator.mdx#throw) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterator.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterator.mdx new file mode 100644 index 0000000000..47c92b1522 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterator.mdx @@ -0,0 +1,167 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AsyncIterator + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).AsyncIterator + +## Type parameters + + + +## Methods + +### next + +▸ **next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> + +#### Parameters + + + +#### Returns + +`Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "IteratorResult", + "type": "[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### return + +▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "IteratorResult", + "type": "[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### throw + +▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> + +#### Parameters + + + +#### Returns + +`Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "IteratorResult", + "type": "[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BlobOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BlobOptions.mdx new file mode 100644 index 0000000000..68db6c308c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BlobOptions.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# BlobOptions + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).BlobOptions + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Buffer.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Buffer.mdx new file mode 100644 index 0000000000..8c75be99b1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Buffer.mdx @@ -0,0 +1,5989 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Buffer + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Buffer + +## Properties + + + +## Methods + +### [iterator] + +▸ **[iterator]**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\> + +#### Returns + +[`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +Uint8Array.[iterator] + +___ + +### 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 + + + +#### Returns + +`undefined` \| `number` + + + +#### Inherited from + +Uint8Array.at + +___ + +### 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 + + + +#### Returns + +``0`` \| ``1`` \| ``-1`` + + + +#### Since + +v0.11.13 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.1.90 + +___ + +### copyWithin + +▸ **copyWithin**(`target`, `start`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Inherited from + +Uint8Array.copyWithin + +___ + +### entries + +▸ **entries**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<[`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`](admin_discounts.internal.IterableIterator.mdx)<[`number`, `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v1.1.0 + +#### Overrides + +Uint8Array.entries + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.11.13 + +___ + +### every + +▸ **every**(`predicate`, `thisArg?`): `boolean` + +Determines whether all the members of an array satisfy the specified test. + +#### Parameters + + `unknown`", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thisArg", + "type": "`any`", + "description": "An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +Uint8Array.every + +___ + +### fill + +▸ **fill**(`value`, `offset?`, `end?`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Since + +v0.5.0 + +#### Overrides + +Uint8Array.fill + +___ + +### filter + +▸ **filter**(`predicate`, `thisArg?`): `Uint8Array` + +Returns the elements of an array that meet the condition specified in a callback function. + +#### Parameters + + `any`", + "description": "A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thisArg", + "type": "`any`", + "description": "An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Uint8Array` + + + +#### Inherited from + +Uint8Array.filter + +___ + +### find + +▸ **find**(`predicate`, `thisArg?`): `undefined` \| `number` + +Returns the value of the first element in the array where predicate is true, and undefined +otherwise. + +#### Parameters + + `boolean`", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thisArg", + "type": "`any`", + "description": "If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`undefined` \| `number` + + + +#### Inherited from + +Uint8Array.find + +___ + +### findIndex + +▸ **findIndex**(`predicate`, `thisArg?`): `number` + +Returns the index of the first element in the array where predicate is true, and -1 +otherwise. + +#### Parameters + + `boolean`", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thisArg", + "type": "`any`", + "description": "If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`number` + + + +#### Inherited from + +Uint8Array.findIndex + +___ + +### forEach + +▸ **forEach**(`callbackfn`, `thisArg?`): `void` + +Performs the specified action for each element in an array. + +#### Parameters + + `void`", + "description": "A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thisArg", + "type": "`any`", + "description": "An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +Uint8Array.forEach + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v5.3.0 + +#### Overrides + +Uint8Array.includes + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v1.5.0 + +#### Overrides + +Uint8Array.indexOf + +___ + +### join + +▸ **join**(`separator?`): `string` + +Adds all the elements of an array separated by the specified separator string. + +#### Parameters + + + +#### Returns + +`string` + + + +#### Inherited from + +Uint8Array.join + +___ + +### keys + +▸ **keys**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`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`](admin_discounts.internal.IterableIterator.mdx)<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v1.1.0 + +#### Overrides + +Uint8Array.keys + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v6.0.0 + +#### Overrides + +Uint8Array.lastIndexOf + +___ + +### 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 + + `number`", + "description": "A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thisArg", + "type": "`any`", + "description": "An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Uint8Array` + + + +#### Inherited from + +Uint8Array.map + +___ + +### 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 + + + +#### Returns + +`bigint` + + + +#### Since + +v12.0.0, v10.20.0 + +___ + +### 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 + + + +#### Returns + +`bigint` + + + +#### Since + +v12.0.0, v10.20.0 + +___ + +### 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 + + + +#### Returns + +`bigint` + + + +#### Since + +v12.0.0, v10.20.0 + +___ + +### 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 + + + +#### Returns + +`bigint` + + + +#### Since + +v12.0.0, v10.20.0 + +___ + +### readBigUint64BE + +▸ **readBigUint64BE**(`offset?`): `bigint` + +#### Parameters + + + +#### Returns + +`bigint` + + + +#### Alias + +Buffer.readBigUInt64BE + +#### Since + +v14.10.0, v12.19.0 + +___ + +### readBigUint64LE + +▸ **readBigUint64LE**(`offset?`): `bigint` + +#### Parameters + + + +#### Returns + +`bigint` + + + +#### Alias + +Buffer.readBigUInt64LE + +#### Since + +v14.10.0, v12.19.0 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.0 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.0 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### readUint16BE + +▸ **readUint16BE**(`offset?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.readUInt16BE + +#### Since + +v14.9.0, v12.19.0 + +___ + +### readUint16LE + +▸ **readUint16LE**(`offset?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.readUInt16LE + +#### Since + +v14.9.0, v12.19.0 + +___ + +### readUint32BE + +▸ **readUint32BE**(`offset?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.readUInt32BE + +#### Since + +v14.9.0, v12.19.0 + +___ + +### readUint32LE + +▸ **readUint32LE**(`offset?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.readUInt32LE + +#### Since + +v14.9.0, v12.19.0 + +___ + +### readUint8 + +▸ **readUint8**(`offset?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.readUInt8 + +#### Since + +v14.9.0, v12.19.0 + +___ + +### readUintBE + +▸ **readUintBE**(`offset`, `byteLength`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.readUIntBE + +#### Since + +v14.9.0, v12.19.0 + +___ + +### readUintLE + +▸ **readUintLE**(`offset`, `byteLength`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.readUIntLE + +#### Since + +v14.9.0, v12.19.0 + +___ + +### 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 + + `number`", + "description": "A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`number` + + + +#### Inherited from + +Uint8Array.reduce + +▸ **reduce**(`callbackfn`, `initialValue`): `number` + +#### Parameters + + `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "initialValue", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`number` + + + +#### Inherited from + +Uint8Array.reduce + +▸ **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. + + + +#### Parameters + + `U`", + "description": "A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "initialValue", + "type": "`U`", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`U` + + + +#### Inherited from + +Uint8Array.reduce + +___ + +### 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 + + `number`", + "description": "A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`number` + + + +#### Inherited from + +Uint8Array.reduceRight + +▸ **reduceRight**(`callbackfn`, `initialValue`): `number` + +#### Parameters + + `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "initialValue", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`number` + + + +#### Inherited from + +Uint8Array.reduceRight + +▸ **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. + + + +#### Parameters + + `U`", + "description": "A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "initialValue", + "type": "`U`", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`U` + + + +#### Inherited from + +Uint8Array.reduceRight + +___ + +### reverse + +▸ **reverse**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Overrides + +Uint8Array.reverse + +___ + +### set + +▸ **set**(`array`, `offset?`): `void` + +Sets a value or an array of values. + +#### Parameters + +", + "description": "A typed or untyped array of values to set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "offset", + "type": "`number`", + "description": "The index in the current array at which the values are to be written.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Inherited from + +Uint8Array.set + +___ + +### slice + +▸ **slice**(`start?`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Since + +v0.3.0 + +#### Deprecated + +Use `subarray` instead. + +#### Overrides + +Uint8Array.slice + +___ + +### some + +▸ **some**(`predicate`, `thisArg?`): `boolean` + +Determines whether the specified callback function returns true for any element of an array. + +#### Parameters + + `unknown`", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thisArg", + "type": "`any`", + "description": "An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +Uint8Array.some + +___ + +### sort + +▸ **sort**(`compareFn?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + +Sorts an array. + +#### Parameters + + `number`", + "description": "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) ```", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Inherited from + +Uint8Array.sort + +___ + +### subarray + +▸ **subarray**(`start?`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Since + +v3.0.0 + +#### Overrides + +Uint8Array.subarray + +___ + +### swap16 + +▸ **swap16**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Since + +v5.10.0 + +___ + +### swap32 + +▸ **swap32**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Since + +v5.10.0 + +___ + +### swap64 + +▸ **swap64**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Since + +v6.3.0 + +___ + +### toJSON + +▸ **toJSON**(): { `data`: `number`[] ; `type`: ``"Buffer"`` } + +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` + + + + + +#### Since + +v0.9.2 + +___ + +### toLocaleString + +▸ **toLocaleString**(): `string` + +Converts a number to a string by using the current locale. + +#### Returns + +`string` + + + +#### Inherited from + +Uint8Array.toLocaleString + +___ + +### 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 + + + +#### Returns + +`string` + + + +#### Since + +v0.1.90 + +#### Overrides + +Uint8Array.toString + +___ + +### valueOf + +▸ **valueOf**(): `Uint8Array` + +Returns the primitive value of the specified object. + +#### Returns + +`Uint8Array` + + + +#### Inherited from + +Uint8Array.valueOf + +___ + +### values + +▸ **values**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`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`](admin_discounts.internal.IterableIterator.mdx)<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Since + +v1.1.0 + +#### Overrides + +Uint8Array.values + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.1.90 + +▸ **write**(`string`, `offset`, `encoding?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +▸ **write**(`string`, `offset`, `length`, `encoding?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v12.0.0, v10.20.0 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v12.0.0, v10.20.0 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v12.0.0, v10.20.0 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v12.0.0, v10.20.0 + +___ + +### writeBigUint64BE + +▸ **writeBigUint64BE**(`value`, `offset?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.writeBigUInt64BE + +#### Since + +v14.10.0, v12.19.0 + +___ + +### writeBigUint64LE + +▸ **writeBigUint64LE**(`value`, `offset?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.writeBigUInt64LE + +#### Since + +v14.10.0, v12.19.0 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.0 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.11.15 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.0 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.5.5 + +___ + +### writeUint16BE + +▸ **writeUint16BE**(`value`, `offset?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.writeUInt16BE + +#### Since + +v14.9.0, v12.19.0 + +___ + +### writeUint16LE + +▸ **writeUint16LE**(`value`, `offset?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.writeUInt16LE + +#### Since + +v14.9.0, v12.19.0 + +___ + +### writeUint32BE + +▸ **writeUint32BE**(`value`, `offset?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.writeUInt32BE + +#### Since + +v14.9.0, v12.19.0 + +___ + +### writeUint32LE + +▸ **writeUint32LE**(`value`, `offset?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.writeUInt32LE + +#### Since + +v14.9.0, v12.19.0 + +___ + +### writeUint8 + +▸ **writeUint8**(`value`, `offset?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.writeUInt8 + +#### Since + +v14.9.0, v12.19.0 + +___ + +### writeUintBE + +▸ **writeUintBE**(`value`, `offset`, `byteLength`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.writeUIntBE + +#### Since + +v14.9.0, v12.19.0 + +___ + +### writeUintLE + +▸ **writeUintLE**(`value`, `offset`, `byteLength`): `number` + +#### Parameters + + + +#### Returns + +`number` + + + +#### Alias + +Buffer.writeUIntLE + +#### Since + +v14.9.0, v12.19.0 diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx new file mode 100644 index 0000000000..5b5b21fd6b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx @@ -0,0 +1,866 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# BufferConstructor + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + + + +## Methods + +### alloc + +▸ **alloc**(`size`, `fill?`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Since + +v5.10.0 + +___ + +### allocUnsafe + +▸ **allocUnsafe**(`size`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Since + +v5.10.0 + +___ + +### allocUnsafeSlow + +▸ **allocUnsafeSlow**(`size`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Since + +v5.12.0 + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v0.1.90 + +___ + +### 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 + + + +#### Returns + +``0`` \| ``1`` \| ``-1`` + + + +#### Since + +v0.11.13 + +___ + +### concat + +▸ **concat**(`list`, `totalLength?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Since + +v0.7.11 + +___ + +### copyBytesFrom + +▸ **copyBytesFrom**(`view`, `offset?`, `length?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Since + +v19.8.0 + +___ + +### from + +▸ **from**(`arrayBuffer`, `byteOffset?`, `length?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "byteOffset", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Since + +v5.10.0 + +▸ **from**(`data`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + +Creates a new Buffer using the passed {data} + +#### Parameters + + + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +▸ **from**(`data`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +▸ **from**(`str`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + \\| { `[toPrimitive]`: Method [toPrimitive] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "encoding", + "type": "[`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +___ + +### 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 + + + +#### Returns + +obj is Buffer + + + +#### Since + +v0.1.101 + +___ + +### 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 + + + +#### Returns + +encoding is BufferEncoding + + + +#### Since + +v0.9.1 + +___ + +### of + +▸ **of**(`...items`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + +Creates a new Buffer using the passed {data} + +#### Parameters + + + +#### Returns + +[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CallSite.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CallSite.mdx new file mode 100644 index 0000000000..31b7592762 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CallSite.mdx @@ -0,0 +1,315 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CallSite + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).CallSite + +## Methods + +### getColumnNumber + +▸ **getColumnNumber**(): ``null`` \| `number` + +Current column number [if this function was defined in a script] + +#### Returns + +``null`` \| `number` + + + +___ + +### 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` + + + +___ + +### getFileName + +▸ **getFileName**(): `undefined` \| `string` + +Name of the script [if this function was defined in a script] + +#### Returns + +`undefined` \| `string` + + + +___ + +### getFunction + +▸ **getFunction**(): `undefined` \| `Function` + +Current function + +#### Returns + +`undefined` \| `Function` + + + +___ + +### 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` + + + +___ + +### getLineNumber + +▸ **getLineNumber**(): ``null`` \| `number` + +Current line number [if this function was defined in a script] + +#### Returns + +``null`` \| `number` + + + +___ + +### getMethodName + +▸ **getMethodName**(): ``null`` \| `string` + +Name of the property [of "this" or one of its prototypes] that holds +the current function + +#### Returns + +``null`` \| `string` + + + +___ + +### getThis + +▸ **getThis**(): `unknown` + +Value of "this" + +#### Returns + +`unknown` + + + +___ + +### 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` + + + +___ + +### isConstructor + +▸ **isConstructor**(): `boolean` + +Is this a constructor call? + +#### Returns + +`boolean` + + + +___ + +### isEval + +▸ **isEval**(): `boolean` + +Does this call take place in code defined by a call to eval? + +#### Returns + +`boolean` + + + +___ + +### isNative + +▸ **isNative**(): `boolean` + +Is this call in native V8 code? + +#### Returns + +`boolean` + + + +___ + +### isToplevel + +▸ **isToplevel**(): `boolean` + +Is this a toplevel invocation, that is, is "this" the global object? + +#### Returns + +`boolean` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CreateNoteInput.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CreateNoteInput.mdx new file mode 100644 index 0000000000..8928920ac0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CreateNoteInput.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreateNoteInput + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).CreateNoteInput + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CreateUserInput.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CreateUserInput.mdx new file mode 100644 index 0000000000..206a988fdd --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CreateUserInput.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreateUserInput + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).CreateUserInput + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "role", + "type": "[`UserRoles`](../enums/admin_auth.internal.UserRoles.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.DuplexOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.DuplexOptions.mdx new file mode 100644 index 0000000000..89fb4fba3a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.DuplexOptions.mdx @@ -0,0 +1,434 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DuplexOptions + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).DuplexOptions + +## Properties + + + +## Methods + +### construct + +▸ `Optional` **construct**(`this`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Overrides + +[WritableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx).[construct](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx#construct) + +___ + +### destroy + +▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Overrides + +[WritableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx).[destroy](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx#destroy) + +___ + +### final + +▸ `Optional` **final**(`this`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Overrides + +[WritableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx).[final](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx#final) + +___ + +### read + +▸ `Optional` **read**(`this`, `size`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +#### Overrides + +[ReadableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx).[read](../../internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx#read) + +___ + +### write + +▸ `Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Overrides + +[WritableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx).[write](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx#write) + +___ + +### writev + +▸ `Optional` **writev**(`this`, `chunks`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Overrides + +[WritableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx).[writev](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx#writev) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ErrnoException.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ErrnoException.mdx new file mode 100644 index 0000000000..83faaf98f5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ErrnoException.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ErrnoException + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ErrnoException + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Error.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Error.mdx new file mode 100644 index 0000000000..ceadf00cff --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Error.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Error + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Error + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter-2.md b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.EventEmitter-2.mdx similarity index 52% rename from www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter-2.md rename to www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.EventEmitter-2.mdx index 909ac68f7a..769301e484 100644 --- a/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter-2.md +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.EventEmitter-2.mdx @@ -2,47 +2,60 @@ displayed_sidebar: jsClientSidebar --- -# Interface: EventEmitter +import ParameterTypes from "@site/src/components/ParameterTypes" -[internal](../modules/internal-8.md).EventEmitter +# EventEmitter -## Hierarchy - -- **`EventEmitter`** - - ↳ [`ReadableStream`](internal-8.ReadableStream.md) - - ↳ [`WritableStream`](internal-8.WritableStream.md) - - ↳ [`EventEmitter`](../classes/internal-8.EventEmitter-1.md) +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).EventEmitter ## Methods ### addListener -▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-2.md) +▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) Alias for `emitter.on(eventName, listener)`. #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> #### Returns -[`EventEmitter`](internal-8.EventEmitter-2.md) +[`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) -**`Since`** + + +#### Since v0.1.26 -#### Defined in - -packages/medusa-js/node_modules/@types/node/events.d.ts:390 - ___ ### emit @@ -89,23 +102,44 @@ myEmitter.emit('event', 1, 2, 3, 4, 5); #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `...args` | `any`[] | + #### Returns `boolean` -**`Since`** + + +#### Since v0.1.26 -#### Defined in - -packages/medusa-js/node_modules/@types/node/events.d.ts:652 - ___ ### eventNames @@ -133,14 +167,30 @@ console.log(myEE.eventNames()); (`string` \| `symbol`)[] -**`Since`** + + +#### Since v6.0.0 -#### Defined in - -packages/medusa-js/node_modules/@types/node/events.d.ts:715 - ___ ### getMaxListeners @@ -154,14 +204,21 @@ set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. `number` -**`Since`** + + +#### Since v1.0.0 -#### Defined in - -packages/medusa-js/node_modules/@types/node/events.d.ts:567 - ___ ### listenerCount @@ -174,23 +231,44 @@ 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`** + + +#### Since v3.2.0 -#### Defined in - -packages/medusa-js/node_modules/@types/node/events.d.ts:661 - ___ ### listeners @@ -209,54 +287,89 @@ console.log(util.inspect(server.listeners('connection'))); #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | + #### Returns `Function`[] -**`Since`** + + +#### 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) +▸ **off**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) Alias for `emitter.removeListener()`. #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> #### Returns -[`EventEmitter`](internal-8.EventEmitter-2.md) +[`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) -**`Since`** + + +#### 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) +▸ **on**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) 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 @@ -287,28 +400,49 @@ myEE.emit('foo'); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> #### Returns -[`EventEmitter`](internal-8.EventEmitter-2.md) +[`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) -**`Since`** + + +#### 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) +▸ **once**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -337,28 +471,49 @@ myEE.emit('foo'); #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event. | -| `listener` | (...`args`: `any`[]) => `void` | The callback function | + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> #### Returns -[`EventEmitter`](internal-8.EventEmitter-2.md) +[`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) -**`Since`** + + +#### 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) +▸ **prependListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) 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 @@ -375,28 +530,49 @@ 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 | + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> #### Returns -[`EventEmitter`](internal-8.EventEmitter-2.md) +[`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) -**`Since`** + + +#### 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) +▸ **prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) 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. @@ -411,23 +587,44 @@ 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 | + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> #### Returns -[`EventEmitter`](internal-8.EventEmitter-2.md) +[`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) -**`Since`** + + +#### Since v6.0.0 -#### Defined in - -packages/medusa-js/node_modules/@types/node/events.d.ts:695 - ___ ### rawListeners @@ -464,27 +661,41 @@ emitter.emit('log'); #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | + #### Returns `Function`[] -**`Since`** + + +#### 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) +▸ **removeAllListeners**(`event?`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) Removes all listeners, or those of the specified `eventName`. @@ -496,27 +707,41 @@ 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) +[`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) -**`Since`** + + +#### 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) +▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) Removes the specified `listener` from the listener array for the event named`eventName`. @@ -600,28 +825,49 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | (...`args`: `any`[]) => `void` | + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> #### Returns -[`EventEmitter`](internal-8.EventEmitter-2.md) +[`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) -**`Since`** + + +#### 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) +▸ **setMaxListeners**(`n`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) 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 @@ -632,18 +878,32 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. #### Parameters -| Name | Type | -| :------ | :------ | -| `n` | `number` | + #### Returns -[`EventEmitter`](internal-8.EventEmitter-2.md) +[`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) -**`Since`** + + +#### 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/internal/interfaces/admin_discounts.internal.EventEmitterOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.EventEmitterOptions.mdx new file mode 100644 index 0000000000..5ee528517a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.EventEmitterOptions.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# EventEmitterOptions + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).EventEmitterOptions + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.FindConfig.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.FindConfig.mdx new file mode 100644 index 0000000000..29e3bf319e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.FindConfig.mdx @@ -0,0 +1,78 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FindConfig + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + + + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ICacheService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ICacheService.mdx new file mode 100644 index 0000000000..4e4a51dc64 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ICacheService.mdx @@ -0,0 +1,147 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ICacheService + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ICacheService + +## Methods + +### get + +▸ **get**<`T`\>(`key`): `Promise`<``null`` \| `T`\> + + + +#### Parameters + + + +#### Returns + +`Promise`<``null`` \| `T`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "``null`` \\| T", + "type": "``null`` \\| `T`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### invalidate + +▸ **invalidate**(`key`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### set + +▸ **set**(`key`, `data`, `ttl?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusModuleService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusModuleService.mdx new file mode 100644 index 0000000000..486f53e72b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusModuleService.mdx @@ -0,0 +1,215 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IEventBusModuleService + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).IEventBusModuleService + +## Implemented by + +- [`AbstractEventBusModuleService`](../classes/admin_discounts.internal.AbstractEventBusModuleService.mdx) + +## Methods + +### emit + +▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **emit**<`T`\>(`data`): `Promise`<`void`\> + + + +#### Parameters + +[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### subscribe + +▸ **subscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusModuleService`](admin_discounts.internal.IEventBusModuleService.mdx) + +#### Parameters + + + +#### Returns + +[`IEventBusModuleService`](admin_discounts.internal.IEventBusModuleService.mdx) + + + +___ + +### unsubscribe + +▸ **unsubscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusModuleService`](admin_discounts.internal.IEventBusModuleService.mdx) + +#### Parameters + + + +#### Returns + +[`IEventBusModuleService`](admin_discounts.internal.IEventBusModuleService.mdx) + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusService.mdx new file mode 100644 index 0000000000..5c5974f8f5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusService.mdx @@ -0,0 +1,221 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IEventBusService + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).IEventBusService + +## Implemented by + +- [`EventBusService`](../classes/admin_discounts.internal.internal.EventBusService.mdx) + +## Methods + +### emit + +▸ **emit**<`T`\>(`event`, `data`, `options?`): `Promise`<`unknown`\> + + + +#### Parameters + + + +#### Returns + +`Promise`<`unknown`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### subscribe + +▸ **subscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusService`](admin_discounts.internal.IEventBusService.mdx) + +#### Parameters + + + +#### Returns + +[`IEventBusService`](admin_discounts.internal.IEventBusService.mdx) + + + +___ + +### unsubscribe + +▸ **unsubscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusService`](admin_discounts.internal.IEventBusService.mdx) + +#### Parameters + + + +#### Returns + +[`IEventBusService`](admin_discounts.internal.IEventBusService.mdx) + + + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`IEventBusService`](admin_discounts.internal.IEventBusService.mdx) + +#### Parameters + + + +#### Returns + +[`IEventBusService`](admin_discounts.internal.IEventBusService.mdx) + + + +#### Inherited from + +[ITransactionBaseService](admin_discounts.internal.ITransactionBaseService.mdx).[withTransaction](admin_discounts.internal.ITransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IFlagRouter.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IFlagRouter.mdx new file mode 100644 index 0000000000..6072a884a2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IFlagRouter.mdx @@ -0,0 +1,34 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IFlagRouter + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).IFlagRouter + +## Implemented by + +- [`FlagRouter`](../classes/admin_discounts.internal.FlagRouter.mdx) + +## Properties + + `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "listFlags", + "type": "() => [`FeatureFlagsResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#featureflagsresponse-1)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IInventoryService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IInventoryService.mdx new file mode 100644 index 0000000000..08c625fbf1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IInventoryService.mdx @@ -0,0 +1,1549 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IInventoryService + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).IInventoryService + +## Methods + +### \_\_joinerConfig + +▸ **__joinerConfig**(): [`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig) + +#### Returns + +[`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig) + + & { `databaseConfig?`: { `extraFields?`: Record<`string`, { `defaultValue?`: `string` ; `nullable?`: `boolean` ; `options?`: 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<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\> ; `relationship`: [`ModuleJoinerRelationship`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerrelationship) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerrelationship)[] ; `schema?`: `string` ; `serviceName?`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### adjustInventory + +▸ **adjustInventory**(`inventoryItemId`, `locationId`, `adjustment`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryLevelDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### confirmInventory + +▸ **confirmInventory**(`inventoryItemId`, `locationIds`, `quantity`, `context?`): `Promise`<`boolean`\> + +#### Parameters + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createInventoryItem + +▸ **createInventoryItem**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryItemDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### createInventoryItems + +▸ **createInventoryItems**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryItemDTO[]", + "type": "[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryItemDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### createInventoryLevel + +▸ **createInventoryLevel**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryLevelDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### createInventoryLevels + +▸ **createInventoryLevels**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryLevelDTO[]", + "type": "[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryLevelDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### createReservationItem + +▸ **createReservationItem**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReservationItemDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### createReservationItems + +▸ **createReservationItems**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReservationItemDTO[]", + "type": "[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReservationItemDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### deleteInventoryItem + +▸ **deleteInventoryItem**(`inventoryItemId`, `context?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### deleteInventoryItemLevelByLocationId + +▸ **deleteInventoryItemLevelByLocationId**(`locationId`, `context?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### deleteInventoryLevel + +▸ **deleteInventoryLevel**(`inventoryLevelId`, `locationId`, `context?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### deleteReservationItem + +▸ **deleteReservationItem**(`reservationItemId`, `context?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### deleteReservationItemByLocationId + +▸ **deleteReservationItemByLocationId**(`locationId`, `context?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### deleteReservationItemsByLineItem + +▸ **deleteReservationItemsByLineItem**(`lineItemId`, `context?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### listInventoryItems + +▸ **listInventoryItems**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[], `number`]\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryItemDTO[]", + "type": "[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### listInventoryLevels + +▸ **listInventoryLevels**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[], `number`]\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryLevelDTO[]", + "type": "[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### listReservationItems + +▸ **listReservationItems**(`selector`, `config?`, `context?`): `Promise`<[[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[], `number`]\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReservationItemDTO[]", + "type": "[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveAvailableQuantity + +▸ **retrieveAvailableQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\> + +#### Parameters + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveInventoryItem + +▸ **retrieveInventoryItem**(`inventoryItemId`, `config?`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryItemDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveInventoryLevel + +▸ **retrieveInventoryLevel**(`inventoryItemId`, `locationId`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryLevelDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveReservationItem + +▸ **retrieveReservationItem**(`reservationId`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReservationItemDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveReservedQuantity + +▸ **retrieveReservedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\> + +#### Parameters + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveStockedQuantity + +▸ **retrieveStockedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\> + +#### Parameters + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateInventoryItem + +▸ **updateInventoryItem**(`inventoryItemId`, `input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryItemDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateInventoryLevel + +▸ **updateInventoryLevel**(`inventoryItemId`, `locationId`, `update`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryLevelDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### updateInventoryLevels + +▸ **updateInventoryLevels**(`updates`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]\> + +#### Parameters + + + +#### Returns + +`Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryLevelDTO[]", + "type": "[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "InventoryLevelDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### updateReservationItem + +▸ **updateReservationItem**(`reservationItemId`, `input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReservationItemDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ISearchService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ISearchService.mdx new file mode 100644 index 0000000000..368729c37a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ISearchService.mdx @@ -0,0 +1,386 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ISearchService + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ISearchService + +## Implemented by + +- [`AbstractSearchService`](../classes/admin_discounts.internal.AbstractSearchService.mdx) + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### addDocuments + +▸ **addDocuments**(`indexName`, `documents`, `type`): `unknown` + +Used to index documents by the search engine provider + +#### Parameters + + + +#### Returns + +`unknown` + + + +___ + +### createIndex + +▸ **createIndex**(`indexName`, `options`): `unknown` + +Used to create an index + +#### Parameters + + + +#### Returns + +`unknown` + + + +___ + +### deleteAllDocuments + +▸ **deleteAllDocuments**(`indexName`): `unknown` + +Used to delete all documents + +#### Parameters + + + +#### Returns + +`unknown` + + + +___ + +### deleteDocument + +▸ **deleteDocument**(`indexName`, `document_id`): `unknown` + +Used to delete document + +#### Parameters + + + +#### Returns + +`unknown` + + + +___ + +### getIndex + +▸ **getIndex**(`indexName`): `unknown` + +Used to get an index + +#### Parameters + + + +#### Returns + +`unknown` + + + +___ + +### replaceDocuments + +▸ **replaceDocuments**(`indexName`, `documents`, `type`): `unknown` + +Used to replace documents + +#### Parameters + + + +#### Returns + +`unknown` + + + +___ + +### search + +▸ **search**(`indexName`, `query`, `options`): `unknown` + +Used to search for a document in an index + +#### Parameters + + + +#### Returns + +`unknown` + + + +___ + +### updateSettings + +▸ **updateSettings**(`indexName`, `settings`): `unknown` + +Used to update the settings of an index + +#### Parameters + + + +#### Returns + +`unknown` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx new file mode 100644 index 0000000000..9d84d81d77 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx @@ -0,0 +1,376 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IStockLocationService + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).IStockLocationService + +## Methods + +### \_\_joinerConfig + +▸ **__joinerConfig**(): [`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig) + +#### Returns + +[`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig) + + & { `databaseConfig?`: { `extraFields?`: Record<`string`, { `defaultValue?`: `string` ; `nullable?`: `boolean` ; `options?`: 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<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\> ; `relationship`: [`ModuleJoinerRelationship`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerrelationship) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerrelationship)[] ; `schema?`: `string` ; `serviceName?`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### create + +▸ **create**(`input`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StockLocationDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`id`, `context?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### list + +▸ **list**(`selector`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[]\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StockLocationDTO[]", + "type": "[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StockLocationDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`, `context?`): `Promise`<[[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[], `number`]\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[], `number`]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StockLocationDTO[]", + "type": "[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "[`SharedContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedcontext)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StockLocationDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`id`, `input`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StockLocationDTO", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ITransactionBaseService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ITransactionBaseService.mdx new file mode 100644 index 0000000000..d951cb091c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ITransactionBaseService.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ITransactionBaseService + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ITransactionBaseService + +## Methods + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ITransactionBaseService`](admin_discounts.internal.ITransactionBaseService.mdx) + +#### Parameters + + + +#### Returns + +[`ITransactionBaseService`](admin_discounts.internal.ITransactionBaseService.mdx) + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterable.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterable.mdx new file mode 100644 index 0000000000..71200593b1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterable.mdx @@ -0,0 +1,60 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Iterable + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Iterable + +## Type parameters + + + +## Methods + +### [iterator] + +▸ **[iterator]**(): [`Iterator`](admin_discounts.internal.Iterator.mdx)<`T`, `any`, `undefined`\> + +#### Returns + +[`Iterator`](admin_discounts.internal.Iterator.mdx)<`T`, `any`, `undefined`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "undefined", + "type": "`undefined`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IterableIterator.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IterableIterator.mdx new file mode 100644 index 0000000000..ed001b4dbf --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IterableIterator.mdx @@ -0,0 +1,184 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IterableIterator + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).IterableIterator + +## Type parameters + + + +## Methods + +### [iterator] + +▸ **[iterator]**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`T`\> + +#### Returns + +[`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`T`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### next + +▸ **next**(`...args`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\> + +#### Parameters + + + +#### Returns + +[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +[Iterator](admin_discounts.internal.Iterator.mdx).[next](admin_discounts.internal.Iterator.mdx#next) + +___ + +### return + +▸ `Optional` **return**(`value?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\> + +#### Parameters + + + +#### Returns + +[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +[Iterator](admin_discounts.internal.Iterator.mdx).[return](admin_discounts.internal.Iterator.mdx#return) + +___ + +### throw + +▸ `Optional` **throw**(`e?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\> + +#### Parameters + + + +#### Returns + +[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +[Iterator](admin_discounts.internal.Iterator.mdx).[throw](admin_discounts.internal.Iterator.mdx#throw) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterator.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterator.mdx new file mode 100644 index 0000000000..407a5b33d8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterator.mdx @@ -0,0 +1,140 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Iterator + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Iterator + +## Type parameters + + + +## Methods + +### next + +▸ **next**(`...args`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\> + +#### Parameters + + + +#### Returns + +[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### return + +▸ `Optional` **return**(`value?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\> + +#### Parameters + + + +#### Returns + +[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### throw + +▸ `Optional` **throw**(`e?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\> + +#### Parameters + + + +#### Returns + +[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IteratorReturnResult.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IteratorReturnResult.mdx new file mode 100644 index 0000000000..8a4f1dbed1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IteratorReturnResult.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IteratorReturnResult + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).IteratorReturnResult + +## Type parameters + + + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IteratorYieldResult.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IteratorYieldResult.mdx new file mode 100644 index 0000000000..dba1ee0054 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IteratorYieldResult.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IteratorYieldResult + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).IteratorYieldResult + +## Type parameters + + + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.JoinerServiceConfig.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.JoinerServiceConfig.mdx new file mode 100644 index 0000000000..d69c537456 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.JoinerServiceConfig.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# JoinerServiceConfig + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).JoinerServiceConfig + +## Properties + +", + "description": "Extra arguments to pass to the remoteFetchData callback", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "extends", + "type": "{ `relationship`: [`JoinerRelationship`](../../admin_discounts/modules/admin_discounts.internal.mdx#joinerrelationship) ; `serviceName`: `string` }[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fieldAlias", + "type": "Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\>", + "description": "alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "primaryKeys", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "relationships", + "type": "[`JoinerRelationship`](../../admin_discounts/modules/admin_discounts.internal.mdx#joinerrelationship)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "serviceName", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.JoinerServiceConfigAlias.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.JoinerServiceConfigAlias.mdx new file mode 100644 index 0000000000..8fb3a71c1a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.JoinerServiceConfigAlias.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# JoinerServiceConfigAlias + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).JoinerServiceConfigAlias + +## Properties + +", + "description": "Extra arguments to pass to the remoteFetchData callback", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Logger.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Logger.mdx new file mode 100644 index 0000000000..d723ddb08a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Logger.mdx @@ -0,0 +1,118 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Logger + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Logger + +## Properties + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "debug", + "type": "(`message`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "error", + "type": "(`messageOrError`: `any`, `error?`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "failure", + "type": "(`activityId`: `any`, `message`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "info", + "type": "(`message`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "log", + "type": "(...`args`: `any`[]) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "panic", + "type": "(`data`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "progress", + "type": "(`activityId`: `any`, `message`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "setLogLevel", + "type": "(`level`: `string`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shouldLog", + "type": "(`level`: `string`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "success", + "type": "(`activityId`: `any`, `message`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "unsetLogLevel", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "warn", + "type": "(`message`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.NumericalComparisonOperator.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.NumericalComparisonOperator.mdx new file mode 100644 index 0000000000..e766a7acbb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.NumericalComparisonOperator.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# NumericalComparisonOperator + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).NumericalComparisonOperator + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Object.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Object.mdx new file mode 100644 index 0000000000..ea9a88b06d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Object.mdx @@ -0,0 +1,199 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Object + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).Object + +## Properties + + + +## Methods + +### hasOwnProperty + +▸ **hasOwnProperty**(`v`): `boolean` + +Determines whether an object has a property with the specified name. + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### isPrototypeOf + +▸ **isPrototypeOf**(`v`): `boolean` + +Determines whether an object exists in another object's prototype chain. + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### propertyIsEnumerable + +▸ **propertyIsEnumerable**(`v`): `boolean` + +Determines whether a specified property is enumerable. + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### toLocaleString + +▸ **toLocaleString**(): `string` + +Returns a date converted to a string using the current locale. + +#### Returns + +`string` + + + +___ + +### toString + +▸ **toString**(): `string` + +Returns a string representation of an object. + +#### Returns + +`string` + + + +___ + +### valueOf + +▸ **valueOf**(): [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object) + +Returns the primitive value of the specified object. + +#### Returns + +[`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object) + + `any`(`value`: `any`) => `any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.PromiseLike.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.PromiseLike.mdx new file mode 100644 index 0000000000..10f208ffd4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.PromiseLike.mdx @@ -0,0 +1,94 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PromiseLike + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).PromiseLike + +## Type parameters + + + +## Methods + +### then + +▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`TResult1` \| `TResult2`\> + +Attaches callbacks for the resolution and/or rejection of the Promise. + + + +#### Parameters + + `TResult1` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`TResult1`\\>", + "description": "The callback to execute when the Promise is resolved.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "onrejected", + "type": "``null`` \\| (`reason`: `any`) => `TResult2` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`TResult2`\\>", + "description": "The callback to execute when the Promise is rejected.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`TResult1` \| `TResult2`\> + +", + "optional": false, + "defaultValue": "", + "description": "A Promise for the completion of which ever callback is executed.", + "children": [ + { + "name": "TResult1 \\| TResult2", + "type": "`TResult1` \\| `TResult2`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.QueuingStrategy.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.QueuingStrategy.mdx new file mode 100644 index 0000000000..ff3b5a4681 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.QueuingStrategy.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# QueuingStrategy + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).QueuingStrategy + +## Type parameters + + + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.QueuingStrategySize.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.QueuingStrategySize.mdx new file mode 100644 index 0000000000..d1a735f798 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.QueuingStrategySize.mdx @@ -0,0 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# QueuingStrategySize + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).QueuingStrategySize + +## Type parameters + + + +## Callable + +### QueuingStrategySize + +▸ **QueuingStrategySize**(`chunk?`): `number` + +#### Parameters + + + +#### Returns + +`number` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx new file mode 100644 index 0000000000..940ea01d57 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx @@ -0,0 +1,1579 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadWriteStream + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReadWriteStream + +## Properties + + + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\> + +#### Returns + +[`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string \\| Buffer", + "type": "`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +[ReadableStream](admin_discounts.internal.ReadableStream.mdx).[[asyncIterator]](admin_discounts.internal.ReadableStream.mdx#[asynciterator]) + +___ + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[addListener](admin_discounts.internal.WritableStream.mdx#addlistener) + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[emit](admin_discounts.internal.WritableStream.mdx#emit) + +___ + +### end + +▸ **end**(`cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[end](admin_discounts.internal.WritableStream.mdx#end) + +▸ **end**(`data`, `cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[end](admin_discounts.internal.WritableStream.mdx#end) + +▸ **end**(`str`, `encoding?`, `cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[end](admin_discounts.internal.WritableStream.mdx#end) + +___ + +### 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](admin_discounts.internal.WritableStream.mdx).[eventNames](admin_discounts.internal.WritableStream.mdx#eventnames) + +___ + +### 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](admin_discounts.internal.WritableStream.mdx).[getMaxListeners](admin_discounts.internal.WritableStream.mdx#getmaxlisteners) + +___ + +### isPaused + +▸ **isPaused**(): `boolean` + +#### Returns + +`boolean` + + + +#### Inherited from + +[ReadableStream](admin_discounts.internal.ReadableStream.mdx).[isPaused](admin_discounts.internal.ReadableStream.mdx#ispaused) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[listenerCount](admin_discounts.internal.WritableStream.mdx#listenercount) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[listeners](admin_discounts.internal.WritableStream.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Since + +v10.0.0 + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[off](admin_discounts.internal.WritableStream.mdx#off) + +___ + +### on + +▸ **on**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Since + +v0.1.101 + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[on](admin_discounts.internal.WritableStream.mdx#on) + +___ + +### once + +▸ **once**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Since + +v0.3.0 + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[once](admin_discounts.internal.WritableStream.mdx#once) + +___ + +### pause + +▸ **pause**(): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Inherited from + +[ReadableStream](admin_discounts.internal.ReadableStream.mdx).[pause](admin_discounts.internal.ReadableStream.mdx#pause) + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +#### Inherited from + +[ReadableStream](admin_discounts.internal.ReadableStream.mdx).[pipe](admin_discounts.internal.ReadableStream.mdx#pipe) + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[prependListener](admin_discounts.internal.WritableStream.mdx#prependlistener) + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[prependOnceListener](admin_discounts.internal.WritableStream.mdx#prependoncelistener) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[rawListeners](admin_discounts.internal.WritableStream.mdx#rawlisteners) + +___ + +### read + +▸ **read**(`size?`): `string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + +#### Parameters + + + +#### Returns + +`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +#### Inherited from + +[ReadableStream](admin_discounts.internal.ReadableStream.mdx).[read](admin_discounts.internal.ReadableStream.mdx#read) + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +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 + + + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[removeAllListeners](admin_discounts.internal.WritableStream.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[removeListener](admin_discounts.internal.WritableStream.mdx#removelistener) + +___ + +### resume + +▸ **resume**(): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Inherited from + +[ReadableStream](admin_discounts.internal.ReadableStream.mdx).[resume](admin_discounts.internal.ReadableStream.mdx#resume) + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +#### Parameters + + + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Inherited from + +[ReadableStream](admin_discounts.internal.ReadableStream.mdx).[setEncoding](admin_discounts.internal.ReadableStream.mdx#setencoding) + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +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 + + + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Since + +v0.3.5 + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[setMaxListeners](admin_discounts.internal.WritableStream.mdx#setmaxlisteners) + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +#### Parameters + + + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Inherited from + +[ReadableStream](admin_discounts.internal.ReadableStream.mdx).[unpipe](admin_discounts.internal.ReadableStream.mdx#unpipe) + +___ + +### unshift + +▸ **unshift**(`chunk`, `encoding?`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +#### Inherited from + +[ReadableStream](admin_discounts.internal.ReadableStream.mdx).[unshift](admin_discounts.internal.ReadableStream.mdx#unshift) + +___ + +### wrap + +▸ **wrap**(`oldStream`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + +#### Parameters + + + +#### Returns + +[`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) + + + +#### Inherited from + +[ReadableStream](admin_discounts.internal.ReadableStream.mdx).[wrap](admin_discounts.internal.ReadableStream.mdx#wrap) + +___ + +### write + +▸ **write**(`buffer`, `cb?`): `boolean` + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[write](admin_discounts.internal.WritableStream.mdx#write) + +▸ **write**(`str`, `encoding?`, `cb?`): `boolean` + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[WritableStream](admin_discounts.internal.WritableStream.mdx).[write](admin_discounts.internal.WritableStream.mdx#write) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableByteStreamController.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableByteStreamController.mdx new file mode 100644 index 0000000000..081afc0407 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableByteStreamController.mdx @@ -0,0 +1,119 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableByteStreamController + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReadableByteStreamController + +## Properties + + + +## Methods + +### close + +▸ **close**(): `void` + +#### Returns + +`void` + + + +___ + +### enqueue + +▸ **enqueue**(`chunk`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### error + +▸ **error**(`error?`): `void` + +#### Parameters + + + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableByteStreamControllerCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableByteStreamControllerCallback.mdx new file mode 100644 index 0000000000..7d5e1075dd --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableByteStreamControllerCallback.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableByteStreamControllerCallback + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReadableByteStreamControllerCallback + +## Callable + +### ReadableByteStreamControllerCallback + +▸ **ReadableByteStreamControllerCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +#### Parameters + + + +#### Returns + +`void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +", + "type": "`void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream-1.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream-1.mdx new file mode 100644 index 0000000000..792413b3a6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream-1.mdx @@ -0,0 +1,288 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStream + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReadableStream + +This Streams API interface represents a readable stream of byte data. + +## Type parameters + + + +## Properties + + + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`R`\> + +#### Returns + +[`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### getReader + +▸ **getReader**(): [`ReadableStreamDefaultReader`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestreamdefaultreader)<`R`\> + +#### Returns + +[`ReadableStreamDefaultReader`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestreamdefaultreader)<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### pipeThrough + +▸ **pipeThrough**<`T`\>(`transform`, `options?`): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`T`\> + + + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`StreamPipeOptions`](admin_discounts.internal.StreamPipeOptions.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`T`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### pipeTo + +▸ **pipeTo**(`destination`, `options?`): `Promise`<`void`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`StreamPipeOptions`](admin_discounts.internal.StreamPipeOptions.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### tee + +▸ **tee**(): [[`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\>, [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\>] + +#### Returns + +[[`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\>, [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\>] + +, [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\\>]", + "type": "[[`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\\>, [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\\>]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReadableStream", + "type": "[`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "ReadableStream", + "type": "[`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### values + +▸ **values**(`options?`): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`R`\> + +#### Parameters + + + +#### Returns + +[`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream.mdx new file mode 100644 index 0000000000..a614469875 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream.mdx @@ -0,0 +1,1309 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStream + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReadableStream + +## Implemented by + +- [`ReadableBase`](../classes/admin_discounts.internal.ReadableBase.mdx) + +## Properties + + + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\> + +#### Returns + +[`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string \\| Buffer", + "type": "`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[addListener](admin_discounts.internal.EventEmitter-2.mdx#addlistener) + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[emit](admin_discounts.internal.EventEmitter-2.mdx#emit) + +___ + +### 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](admin_discounts.internal.EventEmitter-2.mdx).[eventNames](admin_discounts.internal.EventEmitter-2.mdx#eventnames) + +___ + +### 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](admin_discounts.internal.EventEmitter-2.mdx).[getMaxListeners](admin_discounts.internal.EventEmitter-2.mdx#getmaxlisteners) + +___ + +### isPaused + +▸ **isPaused**(): `boolean` + +#### Returns + +`boolean` + + + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[listenerCount](admin_discounts.internal.EventEmitter-2.mdx#listenercount) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[listeners](admin_discounts.internal.EventEmitter-2.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + + +#### Since + +v10.0.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[off](admin_discounts.internal.EventEmitter-2.mdx#off) + +___ + +### on + +▸ **on**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + + +#### Since + +v0.1.101 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[on](admin_discounts.internal.EventEmitter-2.mdx#on) + +___ + +### once + +▸ **once**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + + +#### Since + +v0.3.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[once](admin_discounts.internal.EventEmitter-2.mdx#once) + +___ + +### pause + +▸ **pause**(): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[prependListener](admin_discounts.internal.EventEmitter-2.mdx#prependlistener) + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[prependOnceListener](admin_discounts.internal.EventEmitter-2.mdx#prependoncelistener) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[rawListeners](admin_discounts.internal.EventEmitter-2.mdx#rawlisteners) + +___ + +### read + +▸ **read**(`size?`): `string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + +#### Parameters + + + +#### Returns + +`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) + + + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +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 + + + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[removeAllListeners](admin_discounts.internal.EventEmitter-2.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[removeListener](admin_discounts.internal.EventEmitter-2.mdx#removelistener) + +___ + +### resume + +▸ **resume**(): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +#### Parameters + + + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +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 + + + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + + +#### Since + +v0.3.5 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[setMaxListeners](admin_discounts.internal.EventEmitter-2.mdx#setmaxlisteners) + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +#### Parameters + + + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + + +___ + +### unshift + +▸ **unshift**(`chunk`, `encoding?`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### wrap + +▸ **wrap**(`oldStream`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + +#### Parameters + + + +#### Returns + +[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultController.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultController.mdx new file mode 100644 index 0000000000..93bffbc8cb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultController.mdx @@ -0,0 +1,124 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamDefaultController + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReadableStreamDefaultController + +## Type parameters + + + +## Properties + + + +## Methods + +### close + +▸ **close**(): `void` + +#### Returns + +`void` + + + +___ + +### enqueue + +▸ **enqueue**(`chunk?`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### error + +▸ **error**(`e?`): `void` + +#### Parameters + + + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadDoneResult.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadDoneResult.mdx new file mode 100644 index 0000000000..ef144a0066 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadDoneResult.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamDefaultReadDoneResult + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReadableStreamDefaultReadDoneResult + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadValueResult.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadValueResult.mdx new file mode 100644 index 0000000000..b5021c2b66 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadValueResult.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamDefaultReadValueResult + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReadableStreamDefaultReadValueResult + +## Type parameters + + + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReader.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReader.mdx new file mode 100644 index 0000000000..0e3ad28267 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReader.mdx @@ -0,0 +1,124 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamDefaultReader + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReadableStreamDefaultReader + +## Type parameters + + + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Inherited from + +[ReadableStreamGenericReader](admin_discounts.internal.ReadableStreamGenericReader.mdx).[cancel](admin_discounts.internal.ReadableStreamGenericReader.mdx#cancel) + +___ + +### read + +▸ **read**(): `Promise`<[`ReadableStreamDefaultReadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestreamdefaultreadresult)<`R`\>\> + +#### Returns + +`Promise`<[`ReadableStreamDefaultReadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestreamdefaultreadresult)<`R`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReadableStreamDefaultReadResult", + "type": "[`ReadableStreamDefaultReadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestreamdefaultreadresult)<`R`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### releaseLock + +▸ **releaseLock**(): `void` + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamErrorCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamErrorCallback.mdx new file mode 100644 index 0000000000..615f0f892b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamErrorCallback.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamErrorCallback + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReadableStreamErrorCallback + +## Callable + +### ReadableStreamErrorCallback + +▸ **ReadableStreamErrorCallback**(`reason`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +#### Parameters + + + +#### Returns + +`void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +", + "type": "`void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamGenericReader.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamGenericReader.mdx new file mode 100644 index 0000000000..797b2ff8af --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamGenericReader.mdx @@ -0,0 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamGenericReader + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReadableStreamGenericReader + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableWritablePair.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableWritablePair.mdx new file mode 100644 index 0000000000..15f25e0888 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableWritablePair.mdx @@ -0,0 +1,51 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableWritablePair + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).ReadableWritablePair + +## Type parameters + + + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "writable", + "type": "[`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`W`\\>", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SharedArrayBuffer.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SharedArrayBuffer.mdx new file mode 100644 index 0000000000..d17344b67a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SharedArrayBuffer.mdx @@ -0,0 +1,82 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SharedArrayBuffer + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).SharedArrayBuffer + +## Properties + + + +## Methods + +### slice + +▸ **slice**(`begin`, `end?`): [`SharedArrayBuffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedarraybuffer) + +Returns a section of an SharedArrayBuffer. + +#### Parameters + + + +#### Returns + +[`SharedArrayBuffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedarraybuffer) + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SharedArrayBufferConstructor.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SharedArrayBufferConstructor.mdx new file mode 100644 index 0000000000..d40128f5ee --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SharedArrayBufferConstructor.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SharedArrayBufferConstructor + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).SharedArrayBufferConstructor + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.StaticEventEmitterOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.StaticEventEmitterOptions.mdx new file mode 100644 index 0000000000..8623d064da --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.StaticEventEmitterOptions.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StaticEventEmitterOptions + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).StaticEventEmitterOptions + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.StreamPipeOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.StreamPipeOptions.mdx new file mode 100644 index 0000000000..6b6800f553 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.StreamPipeOptions.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StreamPipeOptions + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).StreamPipeOptions + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.StringComparisonOperator.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.StringComparisonOperator.mdx new file mode 100644 index 0000000000..a4da7a4121 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.StringComparisonOperator.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StringComparisonOperator + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).StringComparisonOperator + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.TransformOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.TransformOptions.mdx new file mode 100644 index 0000000000..2eea5fa138 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.TransformOptions.mdx @@ -0,0 +1,534 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TransformOptions + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).TransformOptions + +## Properties + + + +## Methods + +### construct + +▸ `Optional` **construct**(`this`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Overrides + +[DuplexOptions](admin_discounts.internal.DuplexOptions.mdx).[construct](admin_discounts.internal.DuplexOptions.mdx#construct) + +___ + +### destroy + +▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Overrides + +[DuplexOptions](admin_discounts.internal.DuplexOptions.mdx).[destroy](admin_discounts.internal.DuplexOptions.mdx#destroy) + +___ + +### final + +▸ `Optional` **final**(`this`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Overrides + +[DuplexOptions](admin_discounts.internal.DuplexOptions.mdx).[final](admin_discounts.internal.DuplexOptions.mdx#final) + +___ + +### flush + +▸ `Optional` **flush**(`this`, `callback`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### read + +▸ `Optional` **read**(`this`, `size`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +#### Overrides + +[DuplexOptions](admin_discounts.internal.DuplexOptions.mdx).[read](admin_discounts.internal.DuplexOptions.mdx#read) + +___ + +### transform + +▸ `Optional` **transform**(`this`, `chunk`, `encoding`, `callback`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### write + +▸ `Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Overrides + +[DuplexOptions](admin_discounts.internal.DuplexOptions.mdx).[write](admin_discounts.internal.DuplexOptions.mdx#write) + +___ + +### writev + +▸ `Optional` **writev**(`this`, `chunks`, `callback`): `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +#### Overrides + +[DuplexOptions](admin_discounts.internal.DuplexOptions.mdx).[writev](admin_discounts.internal.DuplexOptions.mdx#writev) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingByteSource.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingByteSource.mdx new file mode 100644 index 0000000000..7986b9a252 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingByteSource.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingByteSource + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).UnderlyingByteSource + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSink.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSink.mdx new file mode 100644 index 0000000000..3cf6488ca8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSink.mdx @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSink + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).UnderlyingSink + +## Type parameters + + + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkAbortCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkAbortCallback.mdx new file mode 100644 index 0000000000..06d899d5d2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkAbortCallback.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSinkAbortCallback + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).UnderlyingSinkAbortCallback + +## Callable + +### UnderlyingSinkAbortCallback + +▸ **UnderlyingSinkAbortCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +#### Parameters + + + +#### Returns + +`void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +", + "type": "`void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkCloseCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkCloseCallback.mdx new file mode 100644 index 0000000000..e4f8909dfe --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkCloseCallback.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSinkCloseCallback + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).UnderlyingSinkCloseCallback + +## Callable + +### UnderlyingSinkCloseCallback + +▸ **UnderlyingSinkCloseCallback**(): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +#### Returns + +`void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +", + "type": "`void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkStartCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkStartCallback.mdx new file mode 100644 index 0000000000..026fbaebc3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkStartCallback.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSinkStartCallback + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).UnderlyingSinkStartCallback + +## Callable + +### UnderlyingSinkStartCallback + +▸ **UnderlyingSinkStartCallback**(`controller`): `any` + +#### Parameters + + + +#### Returns + +`any` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkWriteCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkWriteCallback.mdx new file mode 100644 index 0000000000..06e723f6cb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkWriteCallback.mdx @@ -0,0 +1,64 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSinkWriteCallback + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).UnderlyingSinkWriteCallback + +## Type parameters + + + +## Callable + +### UnderlyingSinkWriteCallback + +▸ **UnderlyingSinkWriteCallback**(`chunk`, `controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +#### Parameters + + + +#### Returns + +`void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +", + "type": "`void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSource.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSource.mdx new file mode 100644 index 0000000000..1a54506418 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSource.mdx @@ -0,0 +1,59 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSource + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).UnderlyingSource + +## Type parameters + + + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "start", + "type": "[`UnderlyingSourceStartCallback`](admin_discounts.internal.UnderlyingSourceStartCallback.mdx)<`R`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "`undefined`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceCancelCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceCancelCallback.mdx new file mode 100644 index 0000000000..110c97a916 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceCancelCallback.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSourceCancelCallback + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).UnderlyingSourceCancelCallback + +## Callable + +### UnderlyingSourceCancelCallback + +▸ **UnderlyingSourceCancelCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +#### Parameters + + + +#### Returns + +`void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +", + "type": "`void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourcePullCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourcePullCallback.mdx new file mode 100644 index 0000000000..b0e90f90c3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourcePullCallback.mdx @@ -0,0 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSourcePullCallback + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).UnderlyingSourcePullCallback + +## Type parameters + + + +## Callable + +### UnderlyingSourcePullCallback + +▸ **UnderlyingSourcePullCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +", + "type": "`void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceStartCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceStartCallback.mdx new file mode 100644 index 0000000000..6d98ccf55f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceStartCallback.mdx @@ -0,0 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSourceStartCallback + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).UnderlyingSourceStartCallback + +## Type parameters + + + +## Callable + +### UnderlyingSourceStartCallback + +▸ **UnderlyingSourceStartCallback**(`controller`): `any` + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`any` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UpdateUserInput.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UpdateUserInput.mdx new file mode 100644 index 0000000000..c95a70eedc --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UpdateUserInput.mdx @@ -0,0 +1,70 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UpdateUserInput + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).UpdateUserInput + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "role", + "type": "[`UserRoles`](../enums/admin_auth.internal.UserRoles.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream-1.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream-1.mdx new file mode 100644 index 0000000000..d7d8eca2c3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream-1.mdx @@ -0,0 +1,115 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# WritableStream + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + + + +## Properties + + + +## Methods + +### abort + +▸ **abort**(`reason?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### getWriter + +▸ **getWriter**(): [`WritableStreamDefaultWriter`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestreamdefaultwriter)<`W`\> + +#### Returns + +[`WritableStreamDefaultWriter`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestreamdefaultwriter)<`W`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream.mdx new file mode 100644 index 0000000000..23d1bf6cba --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream.mdx @@ -0,0 +1,1192 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# WritableStream + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).WritableStream + +## Implemented by + +- [`WritableBase`](../classes/admin_discounts.internal.WritableBase.mdx) + +## Properties + + + +## Methods + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableStream`](admin_discounts.internal.WritableStream.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[addListener](admin_discounts.internal.EventEmitter-2.mdx#addlistener) + +___ + +### 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 + + + +#### Returns + +`boolean` + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[emit](admin_discounts.internal.EventEmitter-2.mdx#emit) + +___ + +### end + +▸ **end**(`cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableStream`](admin_discounts.internal.WritableStream.mdx) + + + +▸ **end**(`data`, `cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableStream`](admin_discounts.internal.WritableStream.mdx) + + + +▸ **end**(`str`, `encoding?`, `cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableStream`](admin_discounts.internal.WritableStream.mdx) + + + +___ + +### 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](admin_discounts.internal.EventEmitter-2.mdx).[eventNames](admin_discounts.internal.EventEmitter-2.mdx#eventnames) + +___ + +### 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](admin_discounts.internal.EventEmitter-2.mdx).[getMaxListeners](admin_discounts.internal.EventEmitter-2.mdx#getmaxlisteners) + +___ + +### 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 + + + +#### Returns + +`number` + + + +#### Since + +v3.2.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[listenerCount](admin_discounts.internal.EventEmitter-2.mdx#listenercount) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[listeners](admin_discounts.internal.EventEmitter-2.mdx#listeners) + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) + +Alias for `emitter.removeListener()`. + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableStream`](admin_discounts.internal.WritableStream.mdx) + + + +#### Since + +v10.0.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[off](admin_discounts.internal.EventEmitter-2.mdx#off) + +___ + +### on + +▸ **on**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableStream`](admin_discounts.internal.WritableStream.mdx) + + + +#### Since + +v0.1.101 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[on](admin_discounts.internal.EventEmitter-2.mdx#on) + +___ + +### once + +▸ **once**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableStream`](admin_discounts.internal.WritableStream.mdx) + + + +#### Since + +v0.3.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[once](admin_discounts.internal.EventEmitter-2.mdx#once) + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableStream`](admin_discounts.internal.WritableStream.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[prependListener](admin_discounts.internal.EventEmitter-2.mdx#prependlistener) + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) + +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 + + `void`", + "description": "The callback function", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableStream`](admin_discounts.internal.WritableStream.mdx) + + + +#### Since + +v6.0.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[prependOnceListener](admin_discounts.internal.EventEmitter-2.mdx#prependoncelistener) + +___ + +### 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 + + + +#### Returns + +`Function`[] + + + +#### Since + +v9.4.0 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[rawListeners](admin_discounts.internal.EventEmitter-2.mdx#rawlisteners) + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) + +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 + + + +#### Returns + +[`WritableStream`](admin_discounts.internal.WritableStream.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[removeAllListeners](admin_discounts.internal.EventEmitter-2.mdx#removealllisteners) + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) + +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 + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableStream`](admin_discounts.internal.WritableStream.mdx) + + + +#### Since + +v0.1.26 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[removeListener](admin_discounts.internal.EventEmitter-2.mdx#removelistener) + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) + +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 + + + +#### Returns + +[`WritableStream`](admin_discounts.internal.WritableStream.mdx) + + + +#### Since + +v0.3.5 + +#### Inherited from + +[EventEmitter](admin_discounts.internal.EventEmitter-2.mdx).[setMaxListeners](admin_discounts.internal.EventEmitter-2.mdx#setmaxlisteners) + +___ + +### write + +▸ **write**(`buffer`, `cb?`): `boolean` + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +▸ **write**(`str`, `encoding?`, `cb?`): `boolean` + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultController.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultController.mdx new file mode 100644 index 0000000000..f180b89f6b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultController.mdx @@ -0,0 +1,48 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# WritableStreamDefaultController + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + + + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultWriter.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultWriter.mdx new file mode 100644 index 0000000000..ffa5be314a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultWriter.mdx @@ -0,0 +1,166 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# WritableStreamDefaultWriter + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).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 + + + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "desiredSize", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ready", + "type": "`Promise`<`undefined`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### abort + +▸ **abort**(`reason?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### releaseLock + +▸ **releaseLock**(): `void` + +#### Returns + +`void` + + + +___ + +### write + +▸ **write**(`chunk?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._DOMEventTarget.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._DOMEventTarget.mdx new file mode 100644 index 0000000000..be25129ca8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._DOMEventTarget.mdx @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# \_DOMEventTarget + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx)._DOMEventTarget + +## Methods + +### addEventListener + +▸ **addEventListener**(`eventName`, `listener`, `opts?`): `any` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "opts", + "type": "`object`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "opts.once", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`any` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._NodeEventTarget.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._NodeEventTarget.mdx new file mode 100644 index 0000000000..3c9e53226a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._NodeEventTarget.mdx @@ -0,0 +1,51 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# \_NodeEventTarget + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx)._NodeEventTarget + +## Methods + +### once + +▸ **once**(`eventName`, `listener`): [`_NodeEventTarget`](admin_discounts.internal._NodeEventTarget.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`_NodeEventTarget`](admin_discounts.internal._NodeEventTarget.mdx) + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.CustomFindOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.CustomFindOptions.mdx new file mode 100644 index 0000000000..3d6589050d --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.CustomFindOptions.mdx @@ -0,0 +1,75 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomFindOptions + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).CustomFindOptions + +## Type parameters + + + +## Properties + + \\| `FindOptionsSelectByString`<`TModel`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "where", + "type": "`FindOptionsWhere`<`TModel`\\> & { [P in string \\| number \\| symbol]?: TModel[P][] } \\| `FindOptionsWhere`<`TModel`\\>[] & { [P in string \\| number \\| symbol]?: TModel[P][] }", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.FindConfig.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.FindConfig.mdx new file mode 100644 index 0000000000..16c7c1770b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.FindConfig.mdx @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FindConfig + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).FindConfig + +## Type parameters + + + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.FulfillmentService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.FulfillmentService.mdx new file mode 100644 index 0000000000..526e50b710 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.FulfillmentService.mdx @@ -0,0 +1,684 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FulfillmentService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).FulfillmentService + +Fulfillment Provider interface +Fullfillment provider plugin services should extend the AbstractFulfillmentService from this file + +## Implemented by + +- [`AbstractFulfillmentService`](../classes/admin_discounts.internal.internal.AbstractFulfillmentService.mdx) + +## Methods + +### calculatePrice + +▸ **calculatePrice**(`optionData`, `data`, `cart`): `Promise`<`number`\> + +Used to calculate a price for a given shipping option. + +#### Parameters + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### canCalculate + +▸ **canCalculate**(`data`): `Promise`<`boolean`\> + +Used to determine if a shipping option can have a calculated price + +#### Parameters + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`fulfillmentData`): `Promise`<`any`\> + +Cancel a fulfillment using data from the fulfillment + +#### Parameters + + + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### createFulfillment + +▸ **createFulfillment**(`data`, `items`, `order`, `fulfillment`): `Promise`<[`FulfillmentProviderData`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + + + +#### Returns + +`Promise`<[`FulfillmentProviderData`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentproviderdata)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "FulfillmentProviderData", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### createReturn + +▸ **createReturn**(`returnOrder`): `Promise`\> + +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 + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### getFulfillmentDocuments + +▸ **getFulfillmentDocuments**(`data`): `Promise`<`any`\> + +Used to retrieve documents associated with a fulfillment. + +#### Parameters + + + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### 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`[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any[]", + "type": "`any`[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +Return a unique identifier to retrieve the fulfillment plugin provider + +#### Returns + +`string` + + + +___ + +### getReturnDocuments + +▸ **getReturnDocuments**(`data`): `Promise`<`any`\> + +Used to retrieve documents related to a return order. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getShipmentDocuments + +▸ **getShipmentDocuments**(`data`): `Promise`<`any`\> + +Used to retrieve documents related to a shipment. + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieveDocuments + +▸ **retrieveDocuments**(`fulfillmentData`, `documentType`): `Promise`<`any`\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### validateFulfillmentData + +▸ **validateFulfillmentData**(`optionData`, `data`, `cart`): `Promise`\> + +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 + + + +#### Returns + +`Promise`\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "the data to populate `cart.shipping_methods.$.data` this\n is usually important for future actions like generating shipping labels", + "children": [ + { + "name": "Record", + "type": "Record<`string`, `unknown`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`Promise`<`boolean`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "boolean", + "type": "`boolean`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx new file mode 100644 index 0000000000..37edc44fb5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx @@ -0,0 +1,393 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IBatchJobStrategy + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).IBatchJobStrategy + +## Implemented by + +- [`AbstractBatchJobStrategy`](../classes/admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx) + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### buildTemplate + +▸ **buildTemplate**(): `Promise`<`string`\> + +Builds and returns a template file that can be downloaded and filled in + +#### Returns + +`Promise`<`string`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### preProcessBatchJob + +▸ **preProcessBatchJob**(`batchJobId`): `Promise`<`void`\> + +Method for pre-processing a batch job + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### prepareBatchJobForProcessing + +▸ **prepareBatchJobForProcessing**(`batchJobEntity`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\> + +Method for preparing a batch job for processing + +#### Parameters + + + +#### Returns + +`Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "CreateBatchJobInput", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### processJob + +▸ **processJob**(`batchJobId`): `Promise`<`void`\> + +Method does the actual processing of the job. Should report back on the progress of the operation. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`IBatchJobStrategy`](admin_discounts.internal.internal.IBatchJobStrategy.mdx) + +#### Parameters + + + +#### Returns + +[`IBatchJobStrategy`](admin_discounts.internal.internal.IBatchJobStrategy.mdx) + + + +#### Inherited from + +[TransactionBaseService](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ICartCompletionStrategy.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ICartCompletionStrategy.mdx new file mode 100644 index 0000000000..404ebd057a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ICartCompletionStrategy.mdx @@ -0,0 +1,75 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ICartCompletionStrategy + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).ICartCompletionStrategy + +## Implemented by + +- [`AbstractCartCompletionStrategy`](../classes/admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx) + +## Methods + +### complete + +▸ **complete**(`cartId`, `idempotencyKey`, `context`): `Promise`<[`CartCompletionResponse`](../modules/admin_discounts.internal.internal.mdx#cartcompletionresponse)\> + +Takes a cart id and completes the cart. This for example takes place when +creating an order or confirming a swap. + +#### Parameters + + + +#### Returns + +`Promise`<[`CartCompletionResponse`](../modules/admin_discounts.internal.internal.mdx#cartcompletionresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "the response for the completion request", + "children": [ + { + "name": "CartCompletionResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IFileService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IFileService.mdx new file mode 100644 index 0000000000..ccb17a298c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IFileService.mdx @@ -0,0 +1,497 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IFileService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).IFileService + +## Implemented by + +- [`AbstractFileService`](../classes/admin_discounts.internal.internal.AbstractFileService.mdx) + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### delete + +▸ **delete**(`fileData`): `Promise`<`void`\> + +remove file from fileservice + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### getDownloadStream + +▸ **getDownloadStream**(`fileData`): `Promise`<[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)\> + +download file from fileservice as stream + +#### Parameters + + + +#### Returns + +`Promise`<[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "readable stream of the file to download", + "children": [ + { + "name": "ReadableStream", + "type": "[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getPresignedDownloadUrl + +▸ **getPresignedDownloadUrl**(`fileData`): `Promise`<`string`\> + +Generate a presigned download url to obtain a file + +#### Parameters + + + +#### Returns + +`Promise`<`string`\> + +", + "optional": false, + "defaultValue": "", + "description": "presigned url to download the file", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getUploadStreamDescriptor + +▸ **getUploadStreamDescriptor**(`fileData`): `Promise`<[`FileServiceGetUploadStreamResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileservicegetuploadstreamresult)\> + +upload file to fileservice from stream + +#### Parameters + + + +#### Returns + +`Promise`<[`FileServiceGetUploadStreamResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileservicegetuploadstreamresult)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "FileServiceGetUploadStreamResult", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### upload + +▸ **upload**(`file`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> + +upload file to fileservice + +#### Parameters + + + +#### Returns + +`Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "FileServiceUploadResult", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### uploadProtected + +▸ **uploadProtected**(`file`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> + +upload private file to fileservice + +#### Parameters + + + +#### Returns + +`Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "FileServiceUploadResult", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`IFileService`](admin_discounts.internal.internal.IFileService.mdx) + +#### Parameters + + + +#### Returns + +[`IFileService`](admin_discounts.internal.internal.IFileService.mdx) + + + +#### Inherited from + +[TransactionBaseService](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.INotificationService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.INotificationService.mdx new file mode 100644 index 0000000000..02d8676f2e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.INotificationService.mdx @@ -0,0 +1,354 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# INotificationService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).INotificationService + +## Implemented by + +- [`AbstractNotificationService`](../classes/admin_discounts.internal.internal.AbstractNotificationService.mdx) + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### resendNotification + +▸ **resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReturnedData", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### sendNotification + +▸ **sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReturnedData", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`INotificationService`](admin_discounts.internal.internal.INotificationService.mdx) + +#### Parameters + + + +#### Returns + +[`INotificationService`](admin_discounts.internal.internal.INotificationService.mdx) + + + +#### Inherited from + +[TransactionBaseService](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx new file mode 100644 index 0000000000..517d2d2345 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx @@ -0,0 +1,158 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IPriceSelectionStrategy + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).IPriceSelectionStrategy + +## Implemented by + +- [`AbstractPriceSelectionStrategy`](../classes/admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx) + +## Methods + +### calculateVariantPrice + +▸ **calculateVariantPrice**(`data`, `context`): `Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\>\> + +Calculate the original and discount price for a given variant in a set of +circumstances described in the context. + +#### Parameters + + + +#### Returns + +`Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "pricing details in an object containing the calculated lowest price,\nthe default price an all valid prices for the given variant", + "children": [ + { + "name": "Map", + "type": "`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "PriceSelectionResult", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### onVariantsPricesUpdate + +▸ **onVariantsPricesUpdate**(`variantIds`): `Promise`<`void`\> + +Notify price selection strategy that variants prices have been updated. + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`IPriceSelectionStrategy`](admin_discounts.internal.internal.IPriceSelectionStrategy.mdx) + +#### Parameters + + + +#### Returns + +[`IPriceSelectionStrategy`](admin_discounts.internal.internal.IPriceSelectionStrategy.mdx) + + + +#### Inherited from + +[ITransactionBaseService](admin_discounts.internal.ITransactionBaseService.mdx).[withTransaction](admin_discounts.internal.ITransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxCalculationStrategy.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxCalculationStrategy.mdx new file mode 100644 index 0000000000..c8747b7624 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxCalculationStrategy.mdx @@ -0,0 +1,71 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ITaxCalculationStrategy + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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 + + + +#### Returns + +`Promise`<`number`\> + +", + "optional": false, + "defaultValue": "", + "description": "the tax total", + "children": [ + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxService.mdx new file mode 100644 index 0000000000..f3e3439a1b --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxService.mdx @@ -0,0 +1,87 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ITaxService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).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/admin_discounts.internal.internal.AbstractTaxService.mdx) + +## Methods + +### getTaxLines + +▸ **getTaxLines**(`itemLines`, `shippingLines`, `context`): `Promise`<[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]\> + +Retrieves the numerical tax lines for a calculation context. + +#### Parameters + + + +#### Returns + +`Promise`<[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "numerical tax rates that should apply to the provided calculation\n lines", + "children": [ + { + "name": "ProviderTaxLine[]", + "type": "[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ProviderTaxLine", + "type": "[`ProviderLineItemTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providerlineitemtaxline) \\| [`ProviderShippingMethodTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providershippingmethodtaxline)", + "description": "A union type of the possible provider tax lines.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx new file mode 100644 index 0000000000..b9ceb47198 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx @@ -0,0 +1,545 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentProcessor + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).PaymentProcessor + +The new payment service plugin interface +This work is still experimental and can be changed until it becomes stable + +## Implemented by + +- [`AbstractPaymentProcessor`](../classes/admin_discounts.internal.internal.AbstractPaymentProcessor.mdx) + +## Methods + +### authorizePayment + +▸ **authorizePayment**(`paymentSessionData`, `context`): `Promise`<[`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| { `data`: Record<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> + +Authorize an existing session if it is not already authorized + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| { `data`: Record<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> + + ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PaymentProcessorError \\| { `data`: Record<`string`, `unknown`\\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }", + "type": "[`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \\| { `data`: Record<`string`, `unknown`\\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### cancelPayment + +▸ **cancelPayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + +Cancel an existing session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + + \\| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record \\| PaymentProcessorError", + "type": "Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### capturePayment + +▸ **capturePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + +Capture an existing session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + + \\| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record \\| PaymentProcessorError", + "type": "Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### deletePayment + +▸ **deletePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + +Delete an existing session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + + \\| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record \\| PaymentProcessorError", + "type": "Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +Return a unique identifier to retrieve the payment plugin provider + +#### Returns + +`string` + + + +___ + +### getPaymentStatus + +▸ **getPaymentStatus**(`paymentSessionData`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> + +Return the status of the session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AUTHORIZED", + "type": "``\"authorized\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "ERROR", + "type": "``\"error\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_MORE", + "type": "``\"requires_more\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### initiatePayment + +▸ **initiatePayment**(`context`): `Promise`<[`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> + +Initiate a payment session with the external provider + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PaymentProcessorError \\| PaymentProcessorSessionResponse", + "type": "[`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \\| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### refundPayment + +▸ **refundPayment**(`paymentSessionData`, `refundAmount`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + +Refund an existing session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundAmount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + + \\| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record \\| PaymentProcessorError", + "type": "Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrievePayment + +▸ **retrievePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + +Retrieve an existing session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + + \\| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record \\| PaymentProcessorError", + "type": "Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updatePayment + +▸ **updatePayment**(`context`): `Promise`<`void` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> + +Update an existing payment session + +#### Parameters + + + +#### Returns + +`Promise`<`void` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "void \\| PaymentProcessorError \\| PaymentProcessorSessionResponse", + "type": "`void` \\| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \\| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### updatePaymentData + +▸ **updatePaymentData**(`sessionId`, `data`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + +Update the session data for a payment session + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> + + \\| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Record \\| PaymentProcessorError", + "type": "Record<`string`, `unknown`\\> \\| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx new file mode 100644 index 0000000000..ea120588fe --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentProcessorError + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).PaymentProcessorError + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentService.mdx new file mode 100644 index 0000000000..c3a7d87a35 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentService.mdx @@ -0,0 +1,1007 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentService + +[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).PaymentService + +This will be + +#### Deprecated + +in the near future use the new PaymentProcessor interface instead + +## Implemented by + +- [`AbstractPaymentService`](../classes/admin_discounts.internal.internal.AbstractPaymentService.mdx) + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "__container__", + "type": "`any`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "__moduleDeclaration__", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "manager_", + "type": "`EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager_", + "type": "`undefined` \\| `EntityManager`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + + + +#### Inherited from + +TransactionBaseService.activeManager\_ + +## 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. + + + +#### Parameters + + `Promise`<`TResult`\\>", + "description": "the transactional work to be done", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationOrErrorHandler", + "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "the isolation level to be used for the work.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maybeErrorHandlerOrDontFail", + "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>", + "description": "Potential error handler", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult`\> + +", + "optional": false, + "defaultValue": "", + "description": "the result of the transactional work", + "children": [] + } +]} /> + +#### Inherited from + +[TransactionBaseService](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx).[atomicPhase_](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx#atomicphase_) + +___ + +### authorizePayment + +▸ **authorizePayment**(`paymentSession`, `context`): `Promise`<{ `data`: [`Data`](../modules/admin_discounts.internal.internal.mdx#data) ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<{ `data`: [`Data`](../modules/admin_discounts.internal.internal.mdx#data) ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "`object`", + "type": "`object`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future use PaymentProcessor.authorizePayment instead + +___ + +### cancelPayment + +▸ **cancelPayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future use PaymentProcessor.cancelPayment instead + +___ + +### capturePayment + +▸ **capturePayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future use PaymentProcessor.capturePayment instead + +___ + +### createPayment + +▸ **createPayment**(`context`): `Promise`<[`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "PaymentSessionResponse", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future use PaymentProcessor.initiatePayment instead + +▸ **createPayment**(`cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future use createPayment(context: `Cart & PaymentContext): Promise` instead + +___ + +### deletePayment + +▸ **deletePayment**(`paymentSession`): `Promise`<`void`\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Deprecated + +in the near future use PaymentProcessor.cancelPayment instead + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +#### Returns + +`string` + + + +___ + +### getPaymentData + +▸ **getPaymentData**(`paymentSession`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future use PaymentProcessor.retrievePayment instead + +___ + +### getStatus + +▸ **getStatus**(`data`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "AUTHORIZED", + "type": "``\"authorized\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "ERROR", + "type": "``\"error\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_MORE", + "type": "``\"requires_more\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future use PaymentProcessor.getPaymentStatus instead + +___ + +### refundPayment + +▸ **refundPayment**(`payment`, `refundAmount`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future use PaymentProcessor.refundPayment instead + +___ + +### retrievePayment + +▸ **retrievePayment**(`paymentData`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future use PaymentProcessor.retrievePayment instead + +___ + +### retrieveSavedMethods + +▸ **retrieveSavedMethods**(`customer`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data[]", + "type": "[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Deprecated + +in the near future use PaymentProcessor.getSavedMethods instead + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + + \\| { `code`: `string` }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +#### Inherited from + +[TransactionBaseService](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx).[shouldRetryTransaction_](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx#shouldretrytransaction_) + +___ + +### updatePayment + +▸ **updatePayment**(`paymentSessionData`, `context`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data) \| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data) \| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data \\| PaymentSessionResponse", + "type": "[`Data`](../modules/admin_discounts.internal.internal.mdx#data) \\| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +▸ **updatePayment**(`paymentSessionData`, `cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future use PaymentProcessor.updatePayment instead + +___ + +### updatePaymentData + +▸ **updatePaymentData**(`paymentSessionData`, `data`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +This will be + +#### Parameters + + + +#### Returns + +`Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Deprecated + +in the near future use PaymentProcessor.updatePayment instead + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PaymentService`](admin_discounts.internal.internal.PaymentService.mdx) + +#### Parameters + + + +#### Returns + +[`PaymentService`](admin_discounts.internal.internal.PaymentService.mdx) + + + +#### Inherited from + +[TransactionBaseService](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx).[withTransaction](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx#withtransaction) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.BlobPropertyBag.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.BlobPropertyBag.mdx new file mode 100644 index 0000000000..5b43a04ca7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.BlobPropertyBag.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# BlobPropertyBag + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).BlobPropertyBag + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.File.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.File.mdx new file mode 100644 index 0000000000..c8059a469f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.File.mdx @@ -0,0 +1,221 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# File + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).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) + +## Properties + + + +## Methods + +### arrayBuffer + +▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/arrayBuffer) + +#### Returns + +`Promise`<`ArrayBuffer`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Inherited from + +Blob.arrayBuffer + +___ + +### slice + +▸ **slice**(`start?`, `end?`, `contentType?`): `Blob` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) + +#### Parameters + + + +#### Returns + +`Blob` + + + +#### Inherited from + +Blob.slice + +___ + +### stream + +▸ **stream**(): [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`Uint8Array`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/stream) + +#### Returns + +[`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`Uint8Array`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Uint8Array", + "type": "`Uint8Array`", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +Blob.stream + +___ + +### text + +▸ **text**(): `Promise`<`string`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) + +#### Returns + +`Promise`<`string`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +Blob.text diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.FilePropertyBag.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.FilePropertyBag.mdx new file mode 100644 index 0000000000..c19e180d80 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.FilePropertyBag.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilePropertyBag + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).FilePropertyBag + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.QueuingStrategy.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.QueuingStrategy.mdx new file mode 100644 index 0000000000..9832c38fe1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.QueuingStrategy.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# QueuingStrategy + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).QueuingStrategy + +## Type parameters + + + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.QueuingStrategySize.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.QueuingStrategySize.mdx new file mode 100644 index 0000000000..d75c135139 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.QueuingStrategySize.mdx @@ -0,0 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# QueuingStrategySize + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).QueuingStrategySize + +## Type parameters + + + +## Callable + +### QueuingStrategySize + +▸ **QueuingStrategySize**(`chunk`): `number` + +#### Parameters + + + +#### Returns + +`number` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableByteStreamController.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableByteStreamController.mdx new file mode 100644 index 0000000000..536e9c2305 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableByteStreamController.mdx @@ -0,0 +1,127 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableByteStreamController + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).ReadableByteStreamController + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController) + +## Properties + + + +## Methods + +### close + +▸ **close**(): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/close) + +#### Returns + +`void` + + + +___ + +### enqueue + +▸ **enqueue**(`chunk`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/enqueue) + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### error + +▸ **error**(`e?`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/error) + +#### Parameters + + + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStream.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStream.mdx new file mode 100644 index 0000000000..77efeb0c33 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStream.mdx @@ -0,0 +1,305 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStream + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).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 + + + +## Properties + + + +## Methods + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/cancel) + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### getReader + +▸ **getReader**(`options`): [`ReadableStreamBYOBReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreambyobreader) + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader) + +#### Parameters + + + +#### Returns + +[`ReadableStreamBYOBReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreambyobreader) + +) => [`ReadableStreamBYOBReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreambyobreader)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +▸ **getReader**(): [`ReadableStreamDefaultReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\> + +#### Returns + +[`ReadableStreamDefaultReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **getReader**(`options?`): [`ReadableStreamReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreader)<`R`\> + +#### Parameters + + + +#### Returns + +[`ReadableStreamReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreader)<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### pipeThrough + +▸ **pipeThrough**<`T`\>(`transform`, `options?`): [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`T`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeThrough) + + + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`StreamPipeOptions`](admin_uploads.internal.StreamPipeOptions.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`T`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### pipeTo + +▸ **pipeTo**(`destination`, `options?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeTo) + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`StreamPipeOptions`](admin_uploads.internal.StreamPipeOptions.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### tee + +▸ **tee**(): [[`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\>, [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\>] + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/tee) + +#### Returns + +[[`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\>, [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\>] + +, [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\\>]", + "type": "[[`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\\>, [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\\>]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReadableStream", + "type": "[`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "ReadableStream", + "type": "[`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBReader.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBReader.mdx new file mode 100644 index 0000000000..98d06cfb63 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBReader.mdx @@ -0,0 +1,143 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamBYOBReader + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).ReadableStreamBYOBReader + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader) + +## Properties + +", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed)", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Inherited from + +[ReadableStreamGenericReader](admin_uploads.internal.ReadableStreamGenericReader.mdx).[cancel](admin_uploads.internal.ReadableStreamGenericReader.mdx#cancel) + +___ + +### read + +▸ **read**<`T`\>(`view`): `Promise`<[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`T`\>\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read) + + + +#### Parameters + + + +#### Returns + +`Promise`<[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`T`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReadableStreamReadResult", + "type": "[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`T`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### releaseLock + +▸ **releaseLock**(): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/releaseLock) + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBRequest.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBRequest.mdx new file mode 100644 index 0000000000..ff582dc723 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBRequest.mdx @@ -0,0 +1,96 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamBYOBRequest + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).ReadableStreamBYOBRequest + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest) + +## Properties + + + +## Methods + +### respond + +▸ **respond**(`bytesWritten`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respond) + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### respondWithNewView + +▸ **respondWithNewView**(`view`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respondWithNewView) + +#### Parameters + + + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultController.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultController.mdx new file mode 100644 index 0000000000..7afce6bc31 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultController.mdx @@ -0,0 +1,132 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamDefaultController + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).ReadableStreamDefaultController + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController) + +## Type parameters + + + +## Properties + + + +## Methods + +### close + +▸ **close**(): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/close) + +#### Returns + +`void` + + + +___ + +### enqueue + +▸ **enqueue**(`chunk?`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/enqueue) + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### error + +▸ **error**(`e?`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/error) + +#### Parameters + + + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultReader.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultReader.mdx new file mode 100644 index 0000000000..de7b139743 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultReader.mdx @@ -0,0 +1,132 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamDefaultReader + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).ReadableStreamDefaultReader + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader) + +## Type parameters + + + +## Properties + +", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed)", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Inherited from + +[ReadableStreamGenericReader](admin_uploads.internal.ReadableStreamGenericReader.mdx).[cancel](admin_uploads.internal.ReadableStreamGenericReader.mdx#cancel) + +___ + +### read + +▸ **read**(): `Promise`<[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`R`\>\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/read) + +#### Returns + +`Promise`<[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`R`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "ReadableStreamReadResult", + "type": "[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`R`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### releaseLock + +▸ **releaseLock**(): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/releaseLock) + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamGenericReader.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamGenericReader.mdx new file mode 100644 index 0000000000..65ac482aae --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamGenericReader.mdx @@ -0,0 +1,58 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamGenericReader + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).ReadableStreamGenericReader + +## Properties + +", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed)", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamGetReaderOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamGetReaderOptions.mdx new file mode 100644 index 0000000000..e6ace06f85 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamGetReaderOptions.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamGetReaderOptions + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).ReadableStreamGetReaderOptions + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamReadDoneResult.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamReadDoneResult.mdx new file mode 100644 index 0000000000..2d2b877756 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamReadDoneResult.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamReadDoneResult + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).ReadableStreamReadDoneResult + +## Type parameters + + + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamReadValueResult.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamReadValueResult.mdx new file mode 100644 index 0000000000..e445170219 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamReadValueResult.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableStreamReadValueResult + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).ReadableStreamReadValueResult + +## Type parameters + + + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableWritablePair.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableWritablePair.mdx new file mode 100644 index 0000000000..a81d421afe --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableWritablePair.mdx @@ -0,0 +1,51 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReadableWritablePair + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).ReadableWritablePair + +## Type parameters + + + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "writable", + "type": "[`WritableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#writablestream)<`W`\\>", + "description": "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.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.StreamPipeOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.StreamPipeOptions.mdx new file mode 100644 index 0000000000..5a6fac2b8f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.StreamPipeOptions.mdx @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StreamPipeOptions + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).StreamPipeOptions + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingByteSource.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingByteSource.mdx new file mode 100644 index 0000000000..520ffdb9d0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingByteSource.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingByteSource + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).UnderlyingByteSource + +## Properties + + `void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "start", + "type": "(`controller`: [`ReadableByteStreamController`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablebytestreamcontroller)) => `any`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "``\"bytes\"``", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingDefaultSource.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingDefaultSource.mdx new file mode 100644 index 0000000000..5666416277 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingDefaultSource.mdx @@ -0,0 +1,59 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingDefaultSource + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).UnderlyingDefaultSource + +## Type parameters + + + +## Properties + +) => `void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "start", + "type": "(`controller`: [`ReadableStreamDefaultController`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`R`\\>) => `any`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "`undefined`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSink.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSink.mdx new file mode 100644 index 0000000000..14b7d758ac --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSink.mdx @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSink + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).UnderlyingSink + +## Type parameters + + + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkAbortCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkAbortCallback.mdx new file mode 100644 index 0000000000..45e4e476cb --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkAbortCallback.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSinkAbortCallback + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).UnderlyingSinkAbortCallback + +## Callable + +### UnderlyingSinkAbortCallback + +▸ **UnderlyingSinkAbortCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +#### Parameters + + + +#### Returns + +`void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +", + "type": "`void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkCloseCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkCloseCallback.mdx new file mode 100644 index 0000000000..6c4d6d9bbf --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkCloseCallback.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSinkCloseCallback + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).UnderlyingSinkCloseCallback + +## Callable + +### UnderlyingSinkCloseCallback + +▸ **UnderlyingSinkCloseCallback**(): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +#### Returns + +`void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +", + "type": "`void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkStartCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkStartCallback.mdx new file mode 100644 index 0000000000..52c27a7048 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkStartCallback.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSinkStartCallback + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).UnderlyingSinkStartCallback + +## Callable + +### UnderlyingSinkStartCallback + +▸ **UnderlyingSinkStartCallback**(`controller`): `any` + +#### Parameters + + + +#### Returns + +`any` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkWriteCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkWriteCallback.mdx new file mode 100644 index 0000000000..fd8628bcef --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkWriteCallback.mdx @@ -0,0 +1,64 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSinkWriteCallback + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).UnderlyingSinkWriteCallback + +## Type parameters + + + +## Callable + +### UnderlyingSinkWriteCallback + +▸ **UnderlyingSinkWriteCallback**(`chunk`, `controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +#### Parameters + + + +#### Returns + +`void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +", + "type": "`void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSource.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSource.mdx new file mode 100644 index 0000000000..2f8c7fc67c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSource.mdx @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSource + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).UnderlyingSource + +## Type parameters + + + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "start", + "type": "[`UnderlyingSourceStartCallback`](admin_uploads.internal.UnderlyingSourceStartCallback.mdx)<`R`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "``\"bytes\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceCancelCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceCancelCallback.mdx new file mode 100644 index 0000000000..bd703ca614 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceCancelCallback.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSourceCancelCallback + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).UnderlyingSourceCancelCallback + +## Callable + +### UnderlyingSourceCancelCallback + +▸ **UnderlyingSourceCancelCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +#### Parameters + + + +#### Returns + +`void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +", + "type": "`void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourcePullCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourcePullCallback.mdx new file mode 100644 index 0000000000..0f831d24a1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourcePullCallback.mdx @@ -0,0 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSourcePullCallback + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).UnderlyingSourcePullCallback + +## Type parameters + + + +## Callable + +### UnderlyingSourcePullCallback + +▸ **UnderlyingSourcePullCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> + +", + "type": "`void` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceStartCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceStartCallback.mdx new file mode 100644 index 0000000000..18ccc048ee --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceStartCallback.mdx @@ -0,0 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UnderlyingSourceStartCallback + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).UnderlyingSourceStartCallback + +## Type parameters + + + +## Callable + +### UnderlyingSourceStartCallback + +▸ **UnderlyingSourceStartCallback**(`controller`): `any` + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`any` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStream.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStream.mdx new file mode 100644 index 0000000000..8abaf700fc --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStream.mdx @@ -0,0 +1,121 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# WritableStream + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).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 + + + +## Properties + + + +## Methods + +### abort + +▸ **abort**(`reason?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/abort) + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### close + +▸ **close**(): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/close) + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### getWriter + +▸ **getWriter**(): [`WritableStreamDefaultWriter`](../../admin_uploads/modules/admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/getWriter) + +#### Returns + +[`WritableStreamDefaultWriter`](../../admin_uploads/modules/admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultController.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultController.mdx new file mode 100644 index 0000000000..0b192f269f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultController.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# WritableStreamDefaultController + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).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 + + + +## Methods + +### error + +▸ **error**(`e?`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/error) + +#### Parameters + + + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultWriter.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultWriter.mdx new file mode 100644 index 0000000000..bcf816a254 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultWriter.mdx @@ -0,0 +1,173 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# WritableStreamDefaultWriter + +[admin/uploads](../../modules/admin_uploads.mdx).[internal](../../admin_uploads/modules/admin_uploads.internal.mdx).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 + + + +## Properties + +", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/closed)", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "desiredSize", + "type": "``null`` \\| `number`", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize)", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ready", + "type": "`Promise`<`undefined`\\>", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready)", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### abort + +▸ **abort**(`reason?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort) + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### close + +▸ **close**(): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close) + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### releaseLock + +▸ **releaseLock**(): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/releaseLock) + +#### Returns + +`void` + + + +___ + +### write + +▸ **write**(`chunk?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/write) + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosAdapter.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosAdapter.mdx new file mode 100644 index 0000000000..0be60ef1d7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosAdapter.mdx @@ -0,0 +1,52 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AxiosAdapter + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).AxiosAdapter + +## Callable + +### AxiosAdapter + +▸ **AxiosAdapter**(`config`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosBasicCredentials.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosBasicCredentials.mdx new file mode 100644 index 0000000000..7eebce00c5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosBasicCredentials.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AxiosBasicCredentials + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).AxiosBasicCredentials + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosDefaults.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosDefaults.mdx new file mode 100644 index 0000000000..317b60c786 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosDefaults.mdx @@ -0,0 +1,293 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AxiosDefaults + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).AxiosDefaults + +Construct a type with the properties of T except for those in type K. + +## Type parameters + + + +## Properties + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "onUploadProgress", + "type": "(`progressEvent`: `any`) => `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "params", + "type": "`any`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "paramsSerializer", + "type": "(`params`: `any`) => `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "proxy", + "type": "``false`` \\| [`AxiosProxyConfig`](swaps.internal.AxiosProxyConfig.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "raxConfig", + "type": "[`RetryConfig`](swaps.internal.RetryConfig.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "responseType", + "type": "[`ResponseType`](../../swaps/modules/swaps.internal.mdx#responsetype)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "signal", + "type": "`AbortSignal`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "socketPath", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "timeout", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "timeoutErrorMessage", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transformRequest", + "type": "[`AxiosRequestTransformer`](swaps.internal.AxiosRequestTransformer.mdx) \\| [`AxiosRequestTransformer`](swaps.internal.AxiosRequestTransformer.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transformResponse", + "type": "[`AxiosResponseTransformer`](swaps.internal.AxiosResponseTransformer.mdx) \\| [`AxiosResponseTransformer`](swaps.internal.AxiosResponseTransformer.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transitional", + "type": "[`TransitionalOptions`](swaps.internal.TransitionalOptions.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "validateStatus", + "type": "``null`` \\| (`status`: `number`) => `boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withCredentials", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "xsrfCookieName", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "xsrfHeaderName", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosError.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosError.mdx new file mode 100644 index 0000000000..5e14987398 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosError.mdx @@ -0,0 +1,107 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AxiosError + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).AxiosError + +## Type parameters + + + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "isAxiosError", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "message", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "request", + "type": "`any`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "response", + "type": "[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `D`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "stack", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "toJSON", + "type": "() => `object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInstance.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInstance.mdx new file mode 100644 index 0000000000..3929e82291 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInstance.mdx @@ -0,0 +1,776 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AxiosInstance + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).AxiosInstance + +## Callable + +### AxiosInstance + +▸ **AxiosInstance**(`config`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +### AxiosInstance + +▸ **AxiosInstance**(`url`, `config?`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "interceptors", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "interceptors.request", + "type": "[`AxiosInterceptorManager`](swaps.internal.AxiosInterceptorManager.mdx)<`AxiosRequestConfig`<`any`\\>\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "interceptors.response", + "type": "[`AxiosInterceptorManager`](swaps.internal.AxiosInterceptorManager.mdx)<[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`any`, `any`\\>\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### delete + +▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Inherited from + +[Axios](../classes/swaps.internal.Axios.mdx).[delete](../classes/swaps.internal.Axios.mdx#delete) + +___ + +### get + +▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Inherited from + +[Axios](../classes/swaps.internal.Axios.mdx).[get](../classes/swaps.internal.Axios.mdx#get) + +___ + +### getUri + +▸ **getUri**(`config?`): `string` + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`string` + + + +#### Inherited from + +[Axios](../classes/swaps.internal.Axios.mdx).[getUri](../classes/swaps.internal.Axios.mdx#geturi) + +___ + +### head + +▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Inherited from + +[Axios](../classes/swaps.internal.Axios.mdx).[head](../classes/swaps.internal.Axios.mdx#head) + +___ + +### options + +▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Inherited from + +[Axios](../classes/swaps.internal.Axios.mdx).[options](../classes/swaps.internal.Axios.mdx#options) + +___ + +### patch + +▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Inherited from + +[Axios](../classes/swaps.internal.Axios.mdx).[patch](../classes/swaps.internal.Axios.mdx#patch) + +___ + +### post + +▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Inherited from + +[Axios](../classes/swaps.internal.Axios.mdx).[post](../classes/swaps.internal.Axios.mdx#post) + +___ + +### put + +▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Inherited from + +[Axios](../classes/swaps.internal.Axios.mdx).[put](../classes/swaps.internal.Axios.mdx#put) + +___ + +### request + +▸ **request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\> + + + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`R`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +#### Inherited from + +[Axios](../classes/swaps.internal.Axios.mdx).[request](../classes/swaps.internal.Axios.mdx#request) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInterceptorManager.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInterceptorManager.mdx new file mode 100644 index 0000000000..853c8d5f97 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInterceptorManager.mdx @@ -0,0 +1,109 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AxiosInterceptorManager + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).AxiosInterceptorManager + +## Type parameters + + + +## Methods + +### eject + +▸ **eject**(`id`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### use + +▸ **use**<`T`\>(`onFulfilled?`, `onRejected?`): `number` + + + +#### Parameters + + `T` \\| `Promise`<`T`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "onRejected", + "type": "(`error`: `any`) => `any`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`number` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosPromise.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosPromise.mdx new file mode 100644 index 0000000000..43e1cea6ee --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosPromise.mdx @@ -0,0 +1,230 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AxiosPromise + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).AxiosPromise + +## Type parameters + + + +## Properties + + + +## Methods + +### catch + +▸ **catch**<`TResult`\>(`onrejected?`): `Promise`<[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `any`\> \| `TResult`\> + +Attaches a callback for only the rejection of the Promise. + + + +#### Parameters + + `TResult` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`TResult`\\>", + "description": "The callback to execute when the Promise is rejected.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `any`\> \| `TResult`\> + + \\| `TResult`\\>", + "optional": false, + "defaultValue": "", + "description": "A Promise for the completion of the callback.", + "children": [ + { + "name": "AxiosResponse \\| TResult", + "type": "[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `any`\\> \\| `TResult`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +Promise.catch + +___ + +### finally + +▸ **finally**(`onfinally?`): `Promise`<[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`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 + + `void`", + "description": "The callback to execute when the Promise is settled (fulfilled or rejected).", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `any`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "A Promise for the completion of the callback.", + "children": [ + { + "name": "AxiosResponse", + "type": "[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `any`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +#### Inherited from + +Promise.finally + +___ + +### then + +▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`<`TResult1` \| `TResult2`\> + +Attaches callbacks for the resolution and/or rejection of the Promise. + + + +#### Parameters + +) => `TResult1` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`TResult1`\\>", + "description": "The callback to execute when the Promise is resolved.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "onrejected", + "type": "``null`` \\| (`reason`: `any`) => `TResult2` \\| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`TResult2`\\>", + "description": "The callback to execute when the Promise is rejected.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`TResult1` \| `TResult2`\> + +", + "optional": false, + "defaultValue": "", + "description": "A Promise for the completion of which ever callback is executed.", + "children": [ + { + "name": "TResult1 \\| TResult2", + "type": "`TResult1` \\| `TResult2`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +#### Inherited from + +Promise.then diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosProxyConfig.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosProxyConfig.mdx new file mode 100644 index 0000000000..f44cf5c7fc --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosProxyConfig.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AxiosProxyConfig + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).AxiosProxyConfig + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosRequestTransformer.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosRequestTransformer.mdx new file mode 100644 index 0000000000..2a379a8e7c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosRequestTransformer.mdx @@ -0,0 +1,51 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AxiosRequestTransformer + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).AxiosRequestTransformer + +## Callable + +### AxiosRequestTransformer + +▸ **AxiosRequestTransformer**(`data`, `headers?`): `any` + +#### Parameters + + + +#### Returns + +`any` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosResponse.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosResponse.mdx new file mode 100644 index 0000000000..615d909d9f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosResponse.mdx @@ -0,0 +1,83 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AxiosResponse + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).AxiosResponse + +## Type parameters + + + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "`T`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "headers", + "type": "[`AxiosResponseHeaders`](../../swaps/modules/swaps.internal.mdx#axiosresponseheaders)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "request", + "type": "`any`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "statusText", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosResponseTransformer.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosResponseTransformer.mdx new file mode 100644 index 0000000000..6447c850a8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosResponseTransformer.mdx @@ -0,0 +1,51 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AxiosResponseTransformer + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).AxiosResponseTransformer + +## Callable + +### AxiosResponseTransformer + +▸ **AxiosResponseTransformer**(`data`, `headers?`): `any` + +#### Parameters + + + +#### Returns + +`any` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.Cancel.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.Cancel.mdx new file mode 100644 index 0000000000..4fc571ed4f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.Cancel.mdx @@ -0,0 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Cancel + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).Cancel + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.CancelToken.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.CancelToken.mdx new file mode 100644 index 0000000000..a0f04892b0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.CancelToken.mdx @@ -0,0 +1,51 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CancelToken + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).CancelToken + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`Cancel`](swaps.internal.Cancel.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +## Methods + +### throwIfRequested + +▸ **throwIfRequested**(): `void` + +#### Returns + +`void` + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.Config.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.Config.mdx new file mode 100644 index 0000000000..0e855ca58c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.Config.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Config + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).Config + +## Properties + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "maxRetries", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "publishableApiKey", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.HTTPResponse.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.HTTPResponse.mdx new file mode 100644 index 0000000000..05cee1e098 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.HTTPResponse.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# HTTPResponse + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).HTTPResponse + +## Properties + + & { `set-cookie?`: `string`[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "request", + "type": "`any`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "statusText", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.HeadersDefaults.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.HeadersDefaults.mdx new file mode 100644 index 0000000000..fa145d25c0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.HeadersDefaults.mdx @@ -0,0 +1,102 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# HeadersDefaults + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).HeadersDefaults + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.RetryConfig.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.RetryConfig.mdx new file mode 100644 index 0000000000..9b71e56e5e --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.RetryConfig.mdx @@ -0,0 +1,120 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RetryConfig + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).RetryConfig + +Configuration for the Axios `request` method. + +## Properties + +) => `void`", + "description": "Function to invoke when a retry attempt is made.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "retry", + "type": "`number`", + "description": "The number of times to retry the request. Defaults to 3.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "retryDelay", + "type": "`number`", + "description": "The amount of time to initially delay the retry. Defaults to 100.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shouldRetry", + "type": "(`err`: [`AxiosError`](swaps.internal.AxiosError.mdx)<`any`, `any`\\>) => `boolean`", + "description": "Function to invoke which determines if you should retry", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "statusCodesToRetry", + "type": "`number`[][]", + "description": "The HTTP response status codes that will automatically be retried. Defaults to: [[100, 199], [429, 429], [500, 599]]", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.TransitionalOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.TransitionalOptions.mdx new file mode 100644 index 0000000000..18374c59d9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.TransitionalOptions.mdx @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TransitionalOptions + +[swaps](../../modules/swaps.mdx).[internal](../../swaps/modules/swaps.internal.mdx).TransitionalOptions + +## Properties + + diff --git a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.EventEmitter.mdx b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.EventEmitter.mdx new file mode 100644 index 0000000000..f5b068445f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.EventEmitter.mdx @@ -0,0 +1,19 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# EventEmitter + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).EventEmitter + +## Interfaces + +- [Abortable](../../EventEmitter/interfaces/admin_discounts.internal.EventEmitter.Abortable.mdx) + +## References + +### EventEmitter + +Re-exports [EventEmitter](../classes/admin_discounts.internal.EventEmitter-1.mdx) diff --git a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-1.mdx b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-1.mdx new file mode 100644 index 0000000000..8082cfccbd --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-1.mdx @@ -0,0 +1,645 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).internal + +## References + +### Address + +Re-exports [Address](../classes/admin_collections.internal.Address.mdx) + +___ + +### AllocationType + +Re-exports [AllocationType](../enums/admin_collections.internal.AllocationType.mdx) + +___ + +### AnalyticsConfig + +Re-exports [AnalyticsConfig](../classes/admin_discounts.internal.internal.AnalyticsConfig.mdx) + +___ + +### BatchJob + +Re-exports [BatchJob](../classes/admin_batch_jobs.internal.BatchJob.mdx) + +___ + +### Cart + +Re-exports [Cart](../classes/admin_collections.internal.Cart.mdx) + +___ + +### CartType + +Re-exports [CartType](../enums/admin_collections.internal.CartType.mdx) + +___ + +### ClaimFulfillmentStatus + +Re-exports [ClaimFulfillmentStatus](../enums/admin_collections.internal.ClaimFulfillmentStatus.mdx) + +___ + +### ClaimImage + +Re-exports [ClaimImage](../classes/admin_collections.internal.ClaimImage.mdx) + +___ + +### ClaimItem + +Re-exports [ClaimItem](../classes/admin_collections.internal.ClaimItem.mdx) + +___ + +### ClaimOrder + +Re-exports [ClaimOrder](../classes/admin_collections.internal.ClaimOrder.mdx) + +___ + +### ClaimPaymentStatus + +Re-exports [ClaimPaymentStatus](../enums/admin_collections.internal.ClaimPaymentStatus.mdx) + +___ + +### ClaimReason + +Re-exports [ClaimReason](../enums/admin_collections.internal.ClaimReason.mdx) + +___ + +### ClaimTag + +Re-exports [ClaimTag](../classes/admin_collections.internal.ClaimTag.mdx) + +___ + +### ClaimType + +Re-exports [ClaimType](../enums/admin_collections.internal.ClaimType.mdx) + +___ + +### Country + +Re-exports [Country](../classes/admin_collections.internal.Country.mdx) + +___ + +### Currency + +Re-exports [Currency](../classes/admin_collections.internal.Currency.mdx) + +___ + +### CustomShippingOption + +Re-exports [CustomShippingOption](../classes/admin_discounts.internal.internal.CustomShippingOption.mdx) + +___ + +### Customer + +Re-exports [Customer](../classes/admin_collections.internal.Customer.mdx) + +___ + +### CustomerGroup + +Re-exports [CustomerGroup](../classes/admin_collections.internal.CustomerGroup.mdx) + +___ + +### Discount + +Re-exports [Discount](../classes/admin_collections.internal.Discount.mdx) + +___ + +### DiscountCondition + +Re-exports [DiscountCondition](../classes/admin_collections.internal.DiscountCondition.mdx) + +___ + +### DiscountConditionCustomerGroup + +Re-exports [DiscountConditionCustomerGroup](../classes/admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx) + +___ + +### DiscountConditionOperator + +Re-exports [DiscountConditionOperator](../enums/admin_collections.internal.DiscountConditionOperator.mdx) + +___ + +### DiscountConditionProduct + +Re-exports [DiscountConditionProduct](../classes/admin_discounts.internal.internal.DiscountConditionProduct.mdx) + +___ + +### DiscountConditionProductCollection + +Re-exports [DiscountConditionProductCollection](../classes/admin_discounts.internal.internal.DiscountConditionProductCollection.mdx) + +___ + +### DiscountConditionProductTag + +Re-exports [DiscountConditionProductTag](../classes/admin_discounts.internal.internal.DiscountConditionProductTag.mdx) + +___ + +### DiscountConditionProductType + +Re-exports [DiscountConditionProductType](../classes/admin_discounts.internal.internal.DiscountConditionProductType.mdx) + +___ + +### DiscountConditionType + +Re-exports [DiscountConditionType](../enums/admin_collections.internal.DiscountConditionType.mdx) + +___ + +### DiscountRule + +Re-exports [DiscountRule](../classes/admin_collections.internal.DiscountRule.mdx) + +___ + +### DiscountRuleType + +Re-exports [DiscountRuleType](../enums/admin_collections.internal.DiscountRuleType.mdx) + +___ + +### DraftOrder + +Re-exports [DraftOrder](../classes/admin_collections.internal.DraftOrder.mdx) + +___ + +### DraftOrderStatus + +Re-exports [DraftOrderStatus](../enums/admin_collections.internal.DraftOrderStatus.mdx) + +___ + +### Fulfillment + +Re-exports [Fulfillment](../classes/admin_collections.internal.Fulfillment.mdx) + +___ + +### FulfillmentItem + +Re-exports [FulfillmentItem](../classes/admin_collections.internal.FulfillmentItem.mdx) + +___ + +### FulfillmentProvider + +Re-exports [FulfillmentProvider](../classes/admin_collections.internal.FulfillmentProvider.mdx) + +___ + +### FulfillmentStatus + +Re-exports [FulfillmentStatus](../enums/admin_collections.internal.FulfillmentStatus.mdx) + +___ + +### GiftCard + +Re-exports [GiftCard](../classes/admin_collections.internal.GiftCard.mdx) + +___ + +### GiftCardTransaction + +Re-exports [GiftCardTransaction](../classes/admin_collections.internal.GiftCardTransaction.mdx) + +___ + +### IdempotencyKey + +Re-exports [IdempotencyKey](../classes/admin_discounts.internal.internal.IdempotencyKey.mdx) + +___ + +### Image + +Re-exports [Image](../classes/admin_collections.internal.Image.mdx) + +___ + +### Invite + +Re-exports [Invite](../classes/admin_discounts.internal.internal.Invite.mdx) + +___ + +### LineItem + +Re-exports [LineItem](../classes/admin_collections.internal.LineItem.mdx) + +___ + +### LineItemAdjustment + +Re-exports [LineItemAdjustment](../classes/admin_collections.internal.LineItemAdjustment.mdx) + +___ + +### LineItemTaxLine + +Re-exports [LineItemTaxLine](../classes/admin_collections.internal.LineItemTaxLine.mdx) + +___ + +### MoneyAmount + +Re-exports [MoneyAmount](../classes/admin_collections.internal.MoneyAmount.mdx) + +___ + +### Note + +Re-exports [Note](../classes/admin_discounts.internal.internal.Note.mdx) + +___ + +### Notification + +Re-exports [Notification](../classes/admin_discounts.internal.internal.Notification.mdx) + +___ + +### Oauth + +Re-exports [Oauth](../classes/admin_discounts.internal.internal.Oauth.mdx) + +___ + +### Order + +Re-exports [Order](../classes/admin_collections.internal.Order.mdx) + +___ + +### OrderEdit + +Re-exports [OrderEdit](../classes/admin_collections.internal.OrderEdit.mdx) + +___ + +### OrderEditItemChangeType + +Re-exports [OrderEditItemChangeType](../enums/admin_collections.internal.OrderEditItemChangeType.mdx) + +___ + +### OrderEditStatus + +Re-exports [OrderEditStatus](../enums/admin_collections.internal.OrderEditStatus.mdx) + +___ + +### OrderItemChange + +Re-exports [OrderItemChange](../classes/admin_collections.internal.OrderItemChange.mdx) + +___ + +### OrderStatus + +Re-exports [OrderStatus](../enums/admin_collections.internal.OrderStatus.mdx) + +___ + +### Payment + +Re-exports [Payment](../classes/admin_collections.internal.Payment.mdx) + +___ + +### PaymentCollection + +Re-exports [PaymentCollection](../classes/admin_collections.internal.PaymentCollection.mdx) + +___ + +### PaymentCollectionStatus + +Re-exports [PaymentCollectionStatus](../enums/admin_collections.internal.PaymentCollectionStatus.mdx) + +___ + +### PaymentCollectionType + +Re-exports [PaymentCollectionType](../enums/admin_discounts.internal.internal.PaymentCollectionType.mdx) + +___ + +### PaymentProvider + +Re-exports [PaymentProvider](../classes/admin_collections.internal.PaymentProvider.mdx) + +___ + +### PaymentSession + +Re-exports [PaymentSession](../classes/admin_collections.internal.PaymentSession.mdx) + +___ + +### PaymentSessionStatus + +Re-exports [PaymentSessionStatus](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) + +___ + +### PaymentStatus + +Re-exports [PaymentStatus](../enums/admin_collections.internal.PaymentStatus.mdx) + +___ + +### PriceList + +Re-exports [PriceList](../classes/admin_collections.internal.PriceList.mdx) + +___ + +### Product + +Re-exports [Product](../classes/admin_collections.internal.Product.mdx) + +___ + +### ProductCategory + +Re-exports [ProductCategory](../classes/admin_collections.internal.ProductCategory.mdx) + +___ + +### ProductCollection + +Re-exports [ProductCollection](../classes/admin_collections.internal.ProductCollection.mdx) + +___ + +### ProductOption + +Re-exports [ProductOption](../classes/admin_collections.internal.ProductOption.mdx) + +___ + +### ProductOptionValue + +Re-exports [ProductOptionValue](../classes/admin_collections.internal.ProductOptionValue.mdx) + +___ + +### ProductStatus + +Re-exports [ProductStatus](../enums/admin_collections.internal.ProductStatus.mdx) + +___ + +### ProductTag + +Re-exports [ProductTag](../classes/admin_collections.internal.ProductTag.mdx) + +___ + +### ProductTaxRate + +Re-exports [ProductTaxRate](../classes/admin_discounts.internal.internal.ProductTaxRate.mdx) + +___ + +### ProductType + +Re-exports [ProductType](../classes/admin_collections.internal.ProductType.mdx) + +___ + +### ProductTypeTaxRate + +Re-exports [ProductTypeTaxRate](../classes/admin_discounts.internal.internal.ProductTypeTaxRate.mdx) + +___ + +### ProductVariant + +Re-exports [ProductVariant](../classes/admin_collections.internal.ProductVariant.mdx) + +___ + +### ProductVariantInventoryItem + +Re-exports [ProductVariantInventoryItem](../classes/admin_collections.internal.ProductVariantInventoryItem.mdx) + +___ + +### ProductVariantMoneyAmount + +Re-exports [ProductVariantMoneyAmount](../classes/admin_discounts.internal.internal.ProductVariantMoneyAmount.mdx) + +___ + +### PublishableApiKey + +Re-exports [PublishableApiKey](../classes/admin_discounts.internal.internal.PublishableApiKey.mdx) + +___ + +### PublishableApiKeySalesChannel + +Re-exports [PublishableApiKeySalesChannel](../classes/admin_discounts.internal.internal.PublishableApiKeySalesChannel.mdx) + +___ + +### Refund + +Re-exports [Refund](../classes/admin_collections.internal.Refund.mdx) + +___ + +### RefundReason + +Re-exports [RefundReason](../enums/admin_discounts.internal.internal.RefundReason.mdx) + +___ + +### Region + +Re-exports [Region](../classes/admin_collections.internal.Region.mdx) + +___ + +### RequirementType + +Re-exports [RequirementType](../enums/admin_collections.internal.RequirementType.mdx) + +___ + +### Return + +Re-exports [Return](../classes/admin_collections.internal.Return.mdx) + +___ + +### ReturnItem + +Re-exports [ReturnItem](../classes/admin_collections.internal.ReturnItem.mdx) + +___ + +### ReturnReason + +Re-exports [ReturnReason](../classes/admin_collections.internal.ReturnReason.mdx) + +___ + +### ReturnStatus + +Re-exports [ReturnStatus](../enums/admin_collections.internal.ReturnStatus.mdx) + +___ + +### SalesChannel + +Re-exports [SalesChannel](../classes/admin_collections.internal.SalesChannel.mdx) + +___ + +### SalesChannelLocation + +Re-exports [SalesChannelLocation](../classes/admin_collections.internal.SalesChannelLocation.mdx) + +___ + +### ShippingMethod + +Re-exports [ShippingMethod](../classes/admin_collections.internal.ShippingMethod.mdx) + +___ + +### ShippingMethodTaxLine + +Re-exports [ShippingMethodTaxLine](../classes/admin_collections.internal.ShippingMethodTaxLine.mdx) + +___ + +### ShippingOption + +Re-exports [ShippingOption](../classes/admin_collections.internal.ShippingOption.mdx) + +___ + +### ShippingOptionPriceType + +Re-exports [ShippingOptionPriceType](../enums/admin_collections.internal.ShippingOptionPriceType.mdx) + +___ + +### ShippingOptionRequirement + +Re-exports [ShippingOptionRequirement](../classes/admin_collections.internal.ShippingOptionRequirement.mdx) + +___ + +### ShippingProfile + +Re-exports [ShippingProfile](../classes/admin_collections.internal.ShippingProfile.mdx) + +___ + +### ShippingProfileType + +Re-exports [ShippingProfileType](../enums/admin_collections.internal.ShippingProfileType.mdx) + +___ + +### ShippingTaxRate + +Re-exports [ShippingTaxRate](../classes/admin_discounts.internal.internal.ShippingTaxRate.mdx) + +___ + +### StagedJob + +Re-exports [StagedJob](../classes/admin_discounts.internal.internal.StagedJob.mdx) + +___ + +### Store + +Re-exports [Store](../classes/admin_discounts.internal.internal.Store.mdx) + +___ + +### Swap + +Re-exports [Swap](../classes/admin_collections.internal.Swap.mdx) + +___ + +### SwapFulfillmentStatus + +Re-exports [SwapFulfillmentStatus](../enums/admin_collections.internal.SwapFulfillmentStatus.mdx) + +___ + +### SwapPaymentStatus + +Re-exports [SwapPaymentStatus](../enums/admin_collections.internal.SwapPaymentStatus.mdx) + +___ + +### TaxProvider + +Re-exports [TaxProvider](../classes/admin_collections.internal.TaxProvider.mdx) + +___ + +### TaxRate + +Re-exports [TaxRate](../classes/admin_collections.internal.TaxRate.mdx) + +___ + +### TrackingLink + +Re-exports [TrackingLink](../classes/admin_collections.internal.TrackingLink.mdx) + +___ + +### User + +Re-exports [User](../classes/admin_auth.internal.User.mdx) + +___ + +### UserRoles + +Re-exports [UserRoles](../enums/admin_auth.internal.UserRoles.mdx) diff --git a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-2.mdx b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-2.mdx new file mode 100644 index 0000000000..d51faf5a2c --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-2.mdx @@ -0,0 +1,1743 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).internal + +## Namespaces + +- [finished](../../internal-2/modules/admin_discounts.internal.internal-2.finished.mdx) +- [pipeline](../../internal-2/modules/admin_discounts.internal.internal-2.pipeline.mdx) + +## Classes + +- [Writable](../../internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx) + +## Interfaces + +- [FinishedOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.FinishedOptions.mdx) +- [Pipe](../../internal-2/interfaces/admin_discounts.internal.internal-2.Pipe.mdx) +- [PipelineOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.PipelineOptions.mdx) +- [ReadableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx) +- [StreamOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.StreamOptions.mdx) +- [WritableOptions](../../internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx) + +## References + +### Duplex + +Re-exports [Duplex](../classes/admin_discounts.internal.Duplex.mdx) + +___ + +### DuplexOptions + +Re-exports [DuplexOptions](../interfaces/admin_discounts.internal.DuplexOptions.mdx) + +___ + +### PassThrough + +Re-exports [PassThrough](../classes/admin_discounts.internal.PassThrough.mdx) + +___ + +### Readable + +Re-exports [Readable](../classes/admin_discounts.internal.Readable.mdx) + +___ + +### Stream + +Re-exports [Stream](../classes/admin_discounts.internal.Stream.mdx) + +___ + +### Transform + +Re-exports [Transform](../classes/admin_discounts.internal.Transform.mdx) + +___ + +### TransformCallback + +Re-exports [TransformCallback](../../admin_discounts/modules/admin_discounts.internal.mdx#transformcallback) + +___ + +### TransformOptions + +Re-exports [TransformOptions](../interfaces/admin_discounts.internal.TransformOptions.mdx) + +## Type Aliases + +### PipelineCallback + +Ƭ **PipelineCallback**<`S`\>: `S` extends [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, infer P\> ? (`err`: [`ErrnoException`](../interfaces/admin_discounts.internal.ErrnoException.mdx) \| ``null``, `value`: `P`) => `void` : (`err`: [`ErrnoException`](../interfaces/admin_discounts.internal.ErrnoException.mdx) \| ``null``) => `void` + +#### Type parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### PipelineDestination + +Ƭ **PipelineDestination**<`S`, `P`\>: `S` extends [`PipelineTransformSource`](admin_discounts.internal.internal-2.mdx#pipelinetransformsource) ? [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`ST`\> \| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`ST`, `P`\> : `never` + +#### Type parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "P", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### PipelineDestinationIterableFunction + +Ƭ **PipelineDestinationIterableFunction**<`T`\>: (`source`: [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\>) => [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\> + +#### Type parameters + + + +#### Type declaration + +▸ (`source`): [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\> + +##### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +[`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### PipelineDestinationPromiseFunction + +Ƭ **PipelineDestinationPromiseFunction**<`T`, `P`\>: (`source`: [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\>) => `Promise`<`P`\> + +#### Type parameters + + + +#### Type declaration + +▸ (`source`): `Promise`<`P`\> + +##### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +`Promise`<`P`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### PipelinePromise + +Ƭ **PipelinePromise**<`S`\>: `S` extends [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, infer P\> ? `Promise`<`P`\> : `Promise`<`void`\> + +#### Type parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### PipelineSource + +Ƭ **PipelineSource**<`T`\>: [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`T`\> \| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\> \| [`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \| [`PipelineSourceFunction`](admin_discounts.internal.internal-2.mdx#pipelinesourcefunction)<`T`\> + +#### Type parameters + + + +___ + +### PipelineSourceFunction + +Ƭ **PipelineSourceFunction**<`T`\>: () => [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`T`\> \| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\> + +#### Type parameters + + + +#### Type declaration + +▸ (): [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`T`\> \| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\> + +##### Returns + +[`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`T`\> \| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\> + + \\| AsyncIterable", + "type": "[`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`T`\\> \\| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### PipelineTransform + +Ƭ **PipelineTransform**<`S`, `U`\>: [`ReadWriteStream`](../interfaces/admin_discounts.internal.ReadWriteStream.mdx) \| (`source`: `S` extends (...`args`: `any`[]) => [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx) \| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx) ? [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`ST`\> : `S`) => [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`U`\> + +#### Type parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "U", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### PipelineTransformSource + +Ƭ **PipelineTransformSource**<`T`\>: [`PipelineSource`](admin_discounts.internal.internal-2.mdx#pipelinesource)<`T`\> \| [`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`any`, `T`\> + +#### Type parameters + + + +## Variables + +### consumers + +• `Const` **consumers**: typeof [`internal`](admin_discounts.internal.internal-4.mdx) + +___ + +### promises + +• `Const` **promises**: typeof [`internal`](admin_discounts.internal.internal-3.mdx) + +## 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(); +}); +``` + + + +#### Parameters + + + +#### Returns + +`T` + + + +#### Since + +v15.4.0 + +___ + +### 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 + + `void`", + "description": "A callback function that takes an optional error argument.", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`fn` + + `void`", + "type": "() => `void`", + "optional": true, + "defaultValue": "", + "description": "A cleanup function which removes all registered listeners.", + "children": [] + } +]} /> + +▸ (): `void` + +##### Returns + +`void` + + + +#### Since + +v10.0.0 + +▸ **finished**(`stream`, `callback`): () => `void` + +#### Parameters + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`fn` + + `void`", + "type": "() => `void`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ (): `void` + +##### Returns + +`void` + + + +___ + +### getDefaultHighWaterMark + +▸ **getDefaultHighWaterMark**(`objectMode`): `number` + +Returns the default highWaterMark used by streams. +Defaults to `16384` (16 KiB), or `16` for `objectMode`. + +#### Parameters + + + +#### Returns + +`number` + + + +#### Since + +v19.9.0 + +___ + +### isErrored + +▸ **isErrored**(`stream`): `boolean` + +Returns whether the stream has encountered an error. + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Since + +v17.3.0, v16.14.0 + +___ + +### isReadable + +▸ **isReadable**(`stream`): `boolean` + +Returns whether the stream is readable. + +#### Parameters + + + +#### Returns + +`boolean` + + + +#### Since + +v17.4.0, v16.14.0 + +___ + +### pipeline + +▸ **pipeline**<`A`, `B`\>(`source`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + +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!!!'); + } + }); +}); +``` + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + +", + "description": "Called when the pipeline is fully done.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + + + +#### Since + +v10.0.0 + +▸ **pipeline**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T1", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + + + +▸ **pipeline**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T1", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T2", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T1`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + + + +▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T1", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T2", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T1`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T3", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T2`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + + + +▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T1", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T2", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T1`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T3", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T2`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T4", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T3`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + +", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + + + +▸ **pipeline**(`streams`, `callback?`): [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + +#### Parameters + + `void`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + + `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "emit", + "type": "(`eventName`: `string` \\| `symbol`, ...`args`: `any`[]) => `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "end", + "type": "(`cb?`: () => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)(`data`: `string` \\| `Uint8Array`, `cb?`: () => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)(`str`: `string`, `encoding?`: [`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding), `cb?`: () => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventNames", + "type": "() => (`string` \\| `symbol`)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "getMaxListeners", + "type": "() => `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "listenerCount", + "type": "(`eventName`: `string` \\| `symbol`, `listener?`: `Function`) => `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "listeners", + "type": "(`eventName`: `string` \\| `symbol`) => `Function`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "off", + "type": "(`eventName`: `string` \\| `symbol`, `listener`: (...`args`: `any`[]) => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "on", + "type": "(`eventName`: `string` \\| `symbol`, `listener`: (...`args`: `any`[]) => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "once", + "type": "(`eventName`: `string` \\| `symbol`, `listener`: (...`args`: `any`[]) => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prependListener", + "type": "(`eventName`: `string` \\| `symbol`, `listener`: (...`args`: `any`[]) => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prependOnceListener", + "type": "(`eventName`: `string` \\| `symbol`, `listener`: (...`args`: `any`[]) => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rawListeners", + "type": "(`eventName`: `string` \\| `symbol`) => `Function`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "removeAllListeners", + "type": "(`event?`: `string` \\| `symbol`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "removeListener", + "type": "(`eventName`: `string` \\| `symbol`, `listener`: (...`args`: `any`[]) => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "setMaxListeners", + "type": "(`n`: `number`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "write", + "type": "(`buffer`: `string` \\| `Uint8Array`, `cb?`: (`err?`: ``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)) => `void`) => `boolean`(`str`: `string`, `encoding?`: [`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding), `cb?`: (`err?`: ``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)) => `void`) => `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +▸ **pipeline**(`stream1`, `stream2`, `...streams`): [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + +#### Parameters + + `void`)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) + + `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "emit", + "type": "(`eventName`: `string` \\| `symbol`, ...`args`: `any`[]) => `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "end", + "type": "(`cb?`: () => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)(`data`: `string` \\| `Uint8Array`, `cb?`: () => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)(`str`: `string`, `encoding?`: [`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding), `cb?`: () => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "eventNames", + "type": "() => (`string` \\| `symbol`)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "getMaxListeners", + "type": "() => `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "listenerCount", + "type": "(`eventName`: `string` \\| `symbol`, `listener?`: `Function`) => `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "listeners", + "type": "(`eventName`: `string` \\| `symbol`) => `Function`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "off", + "type": "(`eventName`: `string` \\| `symbol`, `listener`: (...`args`: `any`[]) => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "on", + "type": "(`eventName`: `string` \\| `symbol`, `listener`: (...`args`: `any`[]) => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "once", + "type": "(`eventName`: `string` \\| `symbol`, `listener`: (...`args`: `any`[]) => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prependListener", + "type": "(`eventName`: `string` \\| `symbol`, `listener`: (...`args`: `any`[]) => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prependOnceListener", + "type": "(`eventName`: `string` \\| `symbol`, `listener`: (...`args`: `any`[]) => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rawListeners", + "type": "(`eventName`: `string` \\| `symbol`) => `Function`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "removeAllListeners", + "type": "(`event?`: `string` \\| `symbol`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "removeListener", + "type": "(`eventName`: `string` \\| `symbol`, `listener`: (...`args`: `any`[]) => `void`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "setMaxListeners", + "type": "(`n`: `number`) => [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "write", + "type": "(`buffer`: `string` \\| `Uint8Array`, `cb?`: (`err?`: ``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)) => `void`) => `boolean`(`str`: `string`, `encoding?`: [`BufferEncoding`](../../admin_discounts/modules/admin_discounts.internal.mdx#bufferencoding), `cb?`: (`err?`: ``null`` \\| [`Error`](../../admin_discounts/modules/admin_discounts.internal.mdx#error)) => `void`) => `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### setDefaultHighWaterMark + +▸ **setDefaultHighWaterMark**(`objectMode`, `value`): `void` + +Sets the default highWaterMark used by streams. + +#### Parameters + + + +#### Returns + +`void` + + + +#### Since + +v19.9.0 diff --git a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-3.mdx b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-3.mdx new file mode 100644 index 0000000000..6eb58b8626 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-3.mdx @@ -0,0 +1,624 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).internal + +## Functions + +### finished + +▸ **finished**(`stream`, `options?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### pipeline + +▸ **pipeline**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + + + +#### Returns + +[`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **pipeline**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T1", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + + + +#### Returns + +[`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **pipeline**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T1", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T2", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T1`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + + + +#### Returns + +[`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T1", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T2", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T1`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T3", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T2`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + + + +#### Returns + +[`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T1", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`A`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T2", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T1`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T3", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T2`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "T4", + "type": "[`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`T3`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "B", + "type": "[`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`string` \\| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer), `any`\\> \\| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`any`\\> \\| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, `any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Parameters + + + +#### Returns + +[`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **pipeline**(`streams`, `options?`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ **pipeline**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-4.mdx b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-4.mdx new file mode 100644 index 0000000000..e9ac9d97c2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-4.mdx @@ -0,0 +1,255 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).internal + +## Functions + +### arrayBuffer + +▸ **arrayBuffer**(`stream`): `Promise`<`ArrayBuffer`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`ArrayBuffer`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### blob + +▸ **blob**(`stream`): `Promise`<[`Blob`](../classes/admin_discounts.internal.Blob.mdx)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Blob`](../classes/admin_discounts.internal.Blob.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "size", + "type": "`number`", + "description": "The total size of the `Blob` in bytes.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "`string`", + "description": "The content-type of the `Blob`.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "arrayBuffer", + "type": "() => `Promise`<`ArrayBuffer`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "slice", + "type": "(`start?`: `number`, `end?`: `number`, `type?`: `string`) => [`Blob`](../classes/admin_discounts.internal.Blob.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "stream", + "type": "() => [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "text", + "type": "() => `Promise`<`string`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### buffer + +▸ **buffer**(`stream`): `Promise`<[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "Buffer", + "type": "[`BufferConstructor`](../interfaces/admin_discounts.internal.BufferConstructor.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### json + +▸ **json**(`stream`): `Promise`<`unknown`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`unknown`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### text + +▸ **text**(`stream`): `Promise`<`string`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`string`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal.mdx b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal.mdx new file mode 100644 index 0000000000..6a10e84179 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal.mdx @@ -0,0 +1,10468 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).internal + +## Enumerations + +- [PaymentCollectionType](../enums/admin_discounts.internal.internal.PaymentCollectionType.mdx) +- [PaymentSessionStatus](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) +- [PostgresError](../enums/admin_discounts.internal.internal.PostgresError.mdx) +- [RefundReason](../enums/admin_discounts.internal.internal.RefundReason.mdx) + +## Classes + +- [AbstractBatchJobStrategy](../classes/admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx) +- [AbstractCartCompletionStrategy](../classes/admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx) +- [AbstractFileService](../classes/admin_discounts.internal.internal.AbstractFileService.mdx) +- [AbstractFulfillmentService](../classes/admin_discounts.internal.internal.AbstractFulfillmentService.mdx) +- [AbstractNotificationService](../classes/admin_discounts.internal.internal.AbstractNotificationService.mdx) +- [AbstractPaymentProcessor](../classes/admin_discounts.internal.internal.AbstractPaymentProcessor.mdx) +- [AbstractPaymentService](../classes/admin_discounts.internal.internal.AbstractPaymentService.mdx) +- [AbstractPriceSelectionStrategy](../classes/admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx) +- [AbstractTaxService](../classes/admin_discounts.internal.internal.AbstractTaxService.mdx) +- [AdminCreateUserRequest](../classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx) +- [AdminDeleteDiscountsDiscountConditionsConditionBatchParams](../classes/admin_discounts.internal.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.mdx) +- [AdminDeleteDiscountsDiscountConditionsConditionParams](../classes/admin_discounts.internal.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.mdx) +- [AdminDeletePriceListPricesPricesReq](../classes/admin_discounts.internal.internal.AdminDeletePriceListPricesPricesReq.mdx) +- [AdminDeletePriceListsPriceListProductsPricesBatchReq](../classes/admin_discounts.internal.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.mdx) +- [AdminDeleteProductCategoriesCategoryProductsBatchParams](../classes/admin_discounts.internal.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.mdx) +- [AdminDeleteProductCategoriesCategoryProductsBatchReq](../classes/admin_discounts.internal.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.mdx) +- [AdminDeletePublishableApiKeySalesChannelsBatchReq](../classes/admin_discounts.internal.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.mdx) +- [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/admin_discounts.internal.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.mdx) +- [AdminDeleteSalesChannelsChannelStockLocationsReq](../classes/admin_discounts.internal.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.mdx) +- [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.mdx) +- [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.mdx) +- [AdminDeleteTaxRatesTaxRateProductsParams](../classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductsParams.mdx) +- [AdminDeleteTaxRatesTaxRateProductsReq](../classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateProductsReq.mdx) +- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.mdx) +- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/admin_discounts.internal.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.mdx) +- [AdminDeleteUploadsReq](../classes/admin_discounts.internal.internal.AdminDeleteUploadsReq.mdx) +- [AdminGetDiscountParams](../classes/admin_discounts.internal.internal.AdminGetDiscountParams.mdx) +- [AdminGetDiscountsDiscountCodeParams](../classes/admin_discounts.internal.internal.AdminGetDiscountsDiscountCodeParams.mdx) +- [AdminGetDraftOrdersParams](../classes/admin_discounts.internal.internal.AdminGetDraftOrdersParams.mdx) +- [AdminGetGiftCardsParams](../classes/admin_discounts.internal.internal.AdminGetGiftCardsParams.mdx) +- [AdminGetInventoryItemsItemLocationLevelsParams](../classes/admin_discounts.internal.internal.AdminGetInventoryItemsItemLocationLevelsParams.mdx) +- [AdminGetInventoryItemsItemParams](../classes/admin_discounts.internal.internal.AdminGetInventoryItemsItemParams.mdx) +- [AdminGetInventoryItemsParams](../classes/admin_discounts.internal.internal.AdminGetInventoryItemsParams.mdx) +- [AdminGetNotesParams](../classes/admin_discounts.internal.internal.AdminGetNotesParams.mdx) +- [AdminGetNotificationsParams](../classes/admin_discounts.internal.internal.AdminGetNotificationsParams.mdx) +- [AdminGetOrdersOrderParams](../classes/admin_discounts.internal.internal.AdminGetOrdersOrderParams.mdx) +- [AdminGetOrdersParams](../classes/admin_discounts.internal.internal.AdminGetOrdersParams.mdx) +- [AdminGetPaymentCollectionsParams](../classes/admin_discounts.internal.internal.AdminGetPaymentCollectionsParams.mdx) +- [AdminGetPriceListPaginationParams](../classes/admin_discounts.internal.internal.AdminGetPriceListPaginationParams.mdx) +- [AdminGetPriceListsPriceListProductsParams](../classes/admin_discounts.internal.internal.AdminGetPriceListsPriceListProductsParams.mdx) +- [AdminGetProductCategoriesParams](../classes/admin_discounts.internal.internal.AdminGetProductCategoriesParams.mdx) +- [AdminGetProductCategoryParams](../classes/admin_discounts.internal.internal.AdminGetProductCategoryParams.mdx) +- [AdminGetProductTagsPaginationParams](../classes/admin_discounts.internal.internal.AdminGetProductTagsPaginationParams.mdx) +- [AdminGetProductTagsParams](../classes/admin_discounts.internal.internal.AdminGetProductTagsParams.mdx) +- [AdminGetProductTypesParams](../classes/admin_discounts.internal.internal.AdminGetProductTypesParams.mdx) +- [AdminGetProductsParams](../classes/admin_discounts.internal.internal.AdminGetProductsParams.mdx) +- [AdminGetProductsVariantsParams](../classes/admin_discounts.internal.internal.AdminGetProductsVariantsParams.mdx) +- [AdminGetRegionsPaginationParams](../classes/admin_discounts.internal.internal.AdminGetRegionsPaginationParams.mdx) +- [AdminGetRegionsParams](../classes/admin_discounts.internal.internal.AdminGetRegionsParams.mdx) +- [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/admin_discounts.internal.internal.AdminGetRegionsRegionFulfillmentOptionsRes.mdx) +- [AdminGetReservationsParams](../classes/admin_discounts.internal.internal.AdminGetReservationsParams.mdx) +- [AdminGetReturnsParams](../classes/admin_discounts.internal.internal.AdminGetReturnsParams.mdx) +- [AdminGetSalesChannelsParams](../classes/admin_discounts.internal.internal.AdminGetSalesChannelsParams.mdx) +- [AdminGetShippingOptionsParams](../classes/admin_discounts.internal.internal.AdminGetShippingOptionsParams.mdx) +- [AdminGetStockLocationsLocationParams](../classes/admin_discounts.internal.internal.AdminGetStockLocationsLocationParams.mdx) +- [AdminGetStockLocationsParams](../classes/admin_discounts.internal.internal.AdminGetStockLocationsParams.mdx) +- [AdminGetSwapsParams](../classes/admin_discounts.internal.internal.AdminGetSwapsParams.mdx) +- [AdminGetTaxRatesParams](../classes/admin_discounts.internal.internal.AdminGetTaxRatesParams.mdx) +- [AdminGetTaxRatesTaxRateParams](../classes/admin_discounts.internal.internal.AdminGetTaxRatesTaxRateParams.mdx) +- [AdminGetVariantParams](../classes/admin_discounts.internal.internal.AdminGetVariantParams.mdx) +- [AdminGetVariantsParams](../classes/admin_discounts.internal.internal.AdminGetVariantsParams.mdx) +- [AdminPostAnalyticsConfigAnalyticsConfigReq](../classes/admin_discounts.internal.internal.AdminPostAnalyticsConfigAnalyticsConfigReq.mdx) +- [AdminPostAnalyticsConfigReq](../classes/admin_discounts.internal.internal.AdminPostAnalyticsConfigReq.mdx) +- [AdminPostDiscountsDiscountParams](../classes/admin_discounts.internal.internal.AdminPostDiscountsDiscountParams.mdx) +- [AdminPostDiscountsParams](../classes/admin_discounts.internal.internal.AdminPostDiscountsParams.mdx) +- [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.mdx) +- [AdminPostDraftOrdersDraftOrderLineItemsReq](../classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.mdx) +- [AdminPostDraftOrdersDraftOrderReq](../classes/admin_discounts.internal.internal.AdminPostDraftOrdersDraftOrderReq.mdx) +- [AdminPostDraftOrdersReq](../classes/admin_discounts.internal.internal.AdminPostDraftOrdersReq.mdx) +- [AdminPostGiftCardsGiftCardReq](../classes/admin_discounts.internal.internal.AdminPostGiftCardsGiftCardReq.mdx) +- [AdminPostGiftCardsReq](../classes/admin_discounts.internal.internal.AdminPostGiftCardsReq.mdx) +- [AdminPostInventoryItemsInventoryItemParams](../classes/admin_discounts.internal.internal.AdminPostInventoryItemsInventoryItemParams.mdx) +- [AdminPostInventoryItemsInventoryItemReq](../classes/admin_discounts.internal.internal.AdminPostInventoryItemsInventoryItemReq.mdx) +- [AdminPostInventoryItemsItemLocationLevelsLevelParams](../classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.mdx) +- [AdminPostInventoryItemsItemLocationLevelsLevelReq](../classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.mdx) +- [AdminPostInventoryItemsItemLocationLevelsParams](../classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsParams.mdx) +- [AdminPostInventoryItemsItemLocationLevelsReq](../classes/admin_discounts.internal.internal.AdminPostInventoryItemsItemLocationLevelsReq.mdx) +- [AdminPostInventoryItemsParams](../classes/admin_discounts.internal.internal.AdminPostInventoryItemsParams.mdx) +- [AdminPostInventoryItemsReq](../classes/admin_discounts.internal.internal.AdminPostInventoryItemsReq.mdx) +- [AdminPostInvitesInviteAcceptReq](../classes/admin_discounts.internal.internal.AdminPostInvitesInviteAcceptReq.mdx) +- [AdminPostInvitesInviteAcceptUserReq](../classes/admin_discounts.internal.internal.AdminPostInvitesInviteAcceptUserReq.mdx) +- [AdminPostInvitesReq](../classes/admin_discounts.internal.internal.AdminPostInvitesReq.mdx) +- [AdminPostNotesNoteReq](../classes/admin_discounts.internal.internal.AdminPostNotesNoteReq.mdx) +- [AdminPostNotesReq](../classes/admin_discounts.internal.internal.AdminPostNotesReq.mdx) +- [AdminPostNotificationsNotificationResendReq](../classes/admin_discounts.internal.internal.AdminPostNotificationsNotificationResendReq.mdx) +- [AdminPostOrderEditsEditLineItemsLineItemReq](../classes/admin_discounts.internal.internal.AdminPostOrderEditsEditLineItemsLineItemReq.mdx) +- [AdminPostOrderEditsEditLineItemsReq](../classes/admin_discounts.internal.internal.AdminPostOrderEditsEditLineItemsReq.mdx) +- [AdminPostOrderEditsOrderEditReq](../classes/admin_discounts.internal.internal.AdminPostOrderEditsOrderEditReq.mdx) +- [AdminPostOrderEditsReq](../classes/admin_discounts.internal.internal.AdminPostOrderEditsReq.mdx) +- [AdminPostOrderEditsRequestConfirmationReq](../classes/admin_discounts.internal.internal.AdminPostOrderEditsRequestConfirmationReq.mdx) +- [AdminPostOrdersClaimCancel](../classes/admin_discounts.internal.internal.AdminPostOrdersClaimCancel.mdx) +- [AdminPostOrdersClaimFulfillmentsCancelParams](../classes/admin_discounts.internal.internal.AdminPostOrdersClaimFulfillmentsCancelParams.mdx) +- [AdminPostOrdersOrderArchiveParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderArchiveParams.mdx) +- [AdminPostOrdersOrderCancel](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderCancel.mdx) +- [AdminPostOrdersOrderCaptureParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderCaptureParams.mdx) +- [AdminPostOrdersOrderClaimsClaimFulfillmentsParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.mdx) +- [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.mdx) +- [AdminPostOrdersOrderClaimsClaimParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimParams.mdx) +- [AdminPostOrdersOrderClaimsClaimReq](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimReq.mdx) +- [AdminPostOrdersOrderClaimsClaimShipmentsParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.mdx) +- [AdminPostOrdersOrderClaimsClaimShipmentsReq](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.mdx) +- [AdminPostOrdersOrderClaimsParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsParams.mdx) +- [AdminPostOrdersOrderClaimsReq](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderClaimsReq.mdx) +- [AdminPostOrdersOrderCompleteParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderCompleteParams.mdx) +- [AdminPostOrdersOrderFulfillementsCancelParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillementsCancelParams.mdx) +- [AdminPostOrdersOrderFulfillmentsParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillmentsParams.mdx) +- [AdminPostOrdersOrderFulfillmentsReq](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderFulfillmentsReq.mdx) +- [AdminPostOrdersOrderParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderParams.mdx) +- [AdminPostOrdersOrderRefundsParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderRefundsParams.mdx) +- [AdminPostOrdersOrderRefundsReq](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderRefundsReq.mdx) +- [AdminPostOrdersOrderReq](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderReq.mdx) +- [AdminPostOrdersOrderReturnsParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderReturnsParams.mdx) +- [AdminPostOrdersOrderReturnsReq](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderReturnsReq.mdx) +- [AdminPostOrdersOrderShipmentParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderShipmentParams.mdx) +- [AdminPostOrdersOrderShipmentReq](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderShipmentReq.mdx) +- [AdminPostOrdersOrderShippingMethodsParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderShippingMethodsParams.mdx) +- [AdminPostOrdersOrderShippingMethodsReq](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderShippingMethodsReq.mdx) +- [AdminPostOrdersOrderSwapFulfillementsCancelParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.mdx) +- [AdminPostOrdersOrderSwapsParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsParams.mdx) +- [AdminPostOrdersOrderSwapsReq](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsReq.mdx) +- [AdminPostOrdersOrderSwapsSwapFulfillmentsParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.mdx) +- [AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.mdx) +- [AdminPostOrdersOrderSwapsSwapProcessPaymentParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.mdx) +- [AdminPostOrdersOrderSwapsSwapShipmentsParams](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.mdx) +- [AdminPostOrdersOrderSwapsSwapShipmentsReq](../classes/admin_discounts.internal.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.mdx) +- [AdminPostOrdersSwapCancelParams](../classes/admin_discounts.internal.internal.AdminPostOrdersSwapCancelParams.mdx) +- [AdminPostPaymentRefundsReq](../classes/admin_discounts.internal.internal.AdminPostPaymentRefundsReq.mdx) +- [AdminPostPriceListPricesPricesReq](../classes/admin_discounts.internal.internal.AdminPostPriceListPricesPricesReq.mdx) +- [AdminPostPriceListsPriceListPriceListReq](../classes/admin_discounts.internal.internal.AdminPostPriceListsPriceListPriceListReq.mdx) +- [AdminPostPriceListsPriceListReq](../classes/admin_discounts.internal.internal.AdminPostPriceListsPriceListReq.mdx) +- [AdminPostProductCategoriesCategoryParams](../classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryParams.mdx) +- [AdminPostProductCategoriesCategoryProductsBatchParams](../classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryProductsBatchParams.mdx) +- [AdminPostProductCategoriesCategoryProductsBatchReq](../classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryProductsBatchReq.mdx) +- [AdminPostProductCategoriesCategoryReq](../classes/admin_discounts.internal.internal.AdminPostProductCategoriesCategoryReq.mdx) +- [AdminPostProductCategoriesParams](../classes/admin_discounts.internal.internal.AdminPostProductCategoriesParams.mdx) +- [AdminPostProductCategoriesReq](../classes/admin_discounts.internal.internal.AdminPostProductCategoriesReq.mdx) +- [AdminPostProductsProductMetadataReq](../classes/admin_discounts.internal.internal.AdminPostProductsProductMetadataReq.mdx) +- [AdminPostProductsProductOptionsOption](../classes/admin_discounts.internal.internal.AdminPostProductsProductOptionsOption.mdx) +- [AdminPostProductsProductOptionsReq](../classes/admin_discounts.internal.internal.AdminPostProductsProductOptionsReq.mdx) +- [AdminPostProductsProductReq](../classes/admin_discounts.internal.internal.AdminPostProductsProductReq.mdx) +- [AdminPostProductsProductVariantsReq](../classes/admin_discounts.internal.internal.AdminPostProductsProductVariantsReq.mdx) +- [AdminPostProductsProductVariantsVariantReq](../classes/admin_discounts.internal.internal.AdminPostProductsProductVariantsVariantReq.mdx) +- [AdminPostProductsReq](../classes/admin_discounts.internal.internal.AdminPostProductsReq.mdx) +- [AdminPostPublishableApiKeySalesChannelsBatchReq](../classes/admin_discounts.internal.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.mdx) +- [AdminPostPublishableApiKeysPublishableApiKeyReq](../classes/admin_discounts.internal.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.mdx) +- [AdminPostPublishableApiKeysReq](../classes/admin_discounts.internal.internal.AdminPostPublishableApiKeysReq.mdx) +- [AdminPostRegionsRegionCountriesReq](../classes/admin_discounts.internal.internal.AdminPostRegionsRegionCountriesReq.mdx) +- [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/admin_discounts.internal.internal.AdminPostRegionsRegionFulfillmentProvidersReq.mdx) +- [AdminPostRegionsRegionPaymentProvidersReq](../classes/admin_discounts.internal.internal.AdminPostRegionsRegionPaymentProvidersReq.mdx) +- [AdminPostRegionsRegionReq](../classes/admin_discounts.internal.internal.AdminPostRegionsRegionReq.mdx) +- [AdminPostRegionsReq](../classes/admin_discounts.internal.internal.AdminPostRegionsReq.mdx) +- [AdminPostReservationsReq](../classes/admin_discounts.internal.internal.AdminPostReservationsReq.mdx) +- [AdminPostReservationsReservationReq](../classes/admin_discounts.internal.internal.AdminPostReservationsReservationReq.mdx) +- [AdminPostReturnReasonsReasonReq](../classes/admin_discounts.internal.internal.AdminPostReturnReasonsReasonReq.mdx) +- [AdminPostReturnReasonsReq](../classes/admin_discounts.internal.internal.AdminPostReturnReasonsReq.mdx) +- [AdminPostReturnsReturnReceiveReq](../classes/admin_discounts.internal.internal.AdminPostReturnsReturnReceiveReq.mdx) +- [AdminPostSalesChannelsChannelProductsBatchReq](../classes/admin_discounts.internal.internal.AdminPostSalesChannelsChannelProductsBatchReq.mdx) +- [AdminPostSalesChannelsChannelStockLocationsReq](../classes/admin_discounts.internal.internal.AdminPostSalesChannelsChannelStockLocationsReq.mdx) +- [AdminPostSalesChannelsReq](../classes/admin_discounts.internal.internal.AdminPostSalesChannelsReq.mdx) +- [AdminPostSalesChannelsSalesChannelReq](../classes/admin_discounts.internal.internal.AdminPostSalesChannelsSalesChannelReq.mdx) +- [AdminPostShippingOptionsOptionReq](../classes/admin_discounts.internal.internal.AdminPostShippingOptionsOptionReq.mdx) +- [AdminPostShippingOptionsReq](../classes/admin_discounts.internal.internal.AdminPostShippingOptionsReq.mdx) +- [AdminPostShippingProfilesProfileReq](../classes/admin_discounts.internal.internal.AdminPostShippingProfilesProfileReq.mdx) +- [AdminPostShippingProfilesReq](../classes/admin_discounts.internal.internal.AdminPostShippingProfilesReq.mdx) +- [AdminPostStockLocationsLocationParams](../classes/admin_discounts.internal.internal.AdminPostStockLocationsLocationParams.mdx) +- [AdminPostStockLocationsLocationReq](../classes/admin_discounts.internal.internal.AdminPostStockLocationsLocationReq.mdx) +- [AdminPostStockLocationsParams](../classes/admin_discounts.internal.internal.AdminPostStockLocationsParams.mdx) +- [AdminPostStockLocationsReq](../classes/admin_discounts.internal.internal.AdminPostStockLocationsReq.mdx) +- [AdminPostStoreReq](../classes/admin_discounts.internal.internal.AdminPostStoreReq.mdx) +- [AdminPostTaxRatesParams](../classes/admin_discounts.internal.internal.AdminPostTaxRatesParams.mdx) +- [AdminPostTaxRatesReq](../classes/admin_discounts.internal.internal.AdminPostTaxRatesReq.mdx) +- [AdminPostTaxRatesTaxRateParams](../classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateParams.mdx) +- [AdminPostTaxRatesTaxRateProductTypesParams](../classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductTypesParams.mdx) +- [AdminPostTaxRatesTaxRateProductTypesReq](../classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductTypesReq.mdx) +- [AdminPostTaxRatesTaxRateProductsParams](../classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductsParams.mdx) +- [AdminPostTaxRatesTaxRateProductsReq](../classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateProductsReq.mdx) +- [AdminPostTaxRatesTaxRateReq](../classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateReq.mdx) +- [AdminPostTaxRatesTaxRateShippingOptionsParams](../classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateShippingOptionsParams.mdx) +- [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/admin_discounts.internal.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.mdx) +- [AdminPostUploadsDownloadUrlReq](../classes/admin_discounts.internal.internal.AdminPostUploadsDownloadUrlReq.mdx) +- [AdminPriceListPricesCreateReq](../classes/admin_discounts.internal.internal.AdminPriceListPricesCreateReq.mdx) +- [AdminPriceListPricesUpdateReq](../classes/admin_discounts.internal.internal.AdminPriceListPricesUpdateReq.mdx) +- [AdminRegionsRes](../classes/admin_discounts.internal.internal.AdminRegionsRes.mdx) +- [AdminResetPasswordRequest](../classes/admin_discounts.internal.internal.AdminResetPasswordRequest.mdx) +- [AdminResetPasswordTokenRequest](../classes/admin_discounts.internal.internal.AdminResetPasswordTokenRequest.mdx) +- [AdminUpdatePaymentCollectionsReq](../classes/admin_discounts.internal.internal.AdminUpdatePaymentCollectionsReq.mdx) +- [AdminUpdateUserRequest](../classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx) +- [AnalyticsConfig](../classes/admin_discounts.internal.internal.AnalyticsConfig.mdx) +- [AnalyticsConfigService](../classes/admin_discounts.internal.internal.AnalyticsConfigService.mdx) +- [AuthService](../classes/admin_discounts.internal.internal.AuthService.mdx) +- [BatchJobService](../classes/admin_discounts.internal.internal.BatchJobService.mdx) +- [CartService](../classes/admin_discounts.internal.internal.CartService.mdx) +- [ClaimItemService](../classes/admin_discounts.internal.internal.ClaimItemService.mdx) +- [ClaimService](../classes/admin_discounts.internal.internal.ClaimService.mdx) +- [CurrencyService](../classes/admin_discounts.internal.internal.CurrencyService.mdx) +- [CustomShippingOption](../classes/admin_discounts.internal.internal.CustomShippingOption.mdx) +- [CustomShippingOptionService](../classes/admin_discounts.internal.internal.CustomShippingOptionService.mdx) +- [CustomerGroupService](../classes/admin_discounts.internal.internal.CustomerGroupService.mdx) +- [CustomerService](../classes/admin_discounts.internal.internal.CustomerService.mdx) +- [DiscountConditionCustomerGroup](../classes/admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx) +- [DiscountConditionProduct](../classes/admin_discounts.internal.internal.DiscountConditionProduct.mdx) +- [DiscountConditionProductCollection](../classes/admin_discounts.internal.internal.DiscountConditionProductCollection.mdx) +- [DiscountConditionProductTag](../classes/admin_discounts.internal.internal.DiscountConditionProductTag.mdx) +- [DiscountConditionProductType](../classes/admin_discounts.internal.internal.DiscountConditionProductType.mdx) +- [DiscountConditionService](../classes/admin_discounts.internal.internal.DiscountConditionService.mdx) +- [DiscountService](../classes/admin_discounts.internal.internal.DiscountService.mdx) +- [DraftOrderService](../classes/admin_discounts.internal.internal.DraftOrderService.mdx) +- [EmptyQueryParams](../classes/admin_discounts.internal.internal.EmptyQueryParams.mdx) +- [EventBusService](../classes/admin_discounts.internal.internal.EventBusService.mdx) +- [FilterableBatchJobProps](../classes/admin_discounts.internal.internal.FilterableBatchJobProps.mdx) +- [FilterablePriceListProps](../classes/admin_discounts.internal.internal.FilterablePriceListProps.mdx) +- [FulfillmentOption](../classes/admin_discounts.internal.internal.FulfillmentOption.mdx) +- [FulfillmentProviderService](../classes/admin_discounts.internal.internal.FulfillmentProviderService.mdx) +- [GetOrderEditsOrderEditParams](../classes/admin_discounts.internal.internal.GetOrderEditsOrderEditParams.mdx) +- [GetOrderEditsParams](../classes/admin_discounts.internal.internal.GetOrderEditsParams.mdx) +- [GetPaymentsParams](../classes/admin_discounts.internal.internal.GetPaymentsParams.mdx) +- [GetPublishableApiKeySalesChannelsParams](../classes/admin_discounts.internal.internal.GetPublishableApiKeySalesChannelsParams.mdx) +- [GetPublishableApiKeysParams](../classes/admin_discounts.internal.internal.GetPublishableApiKeysParams.mdx) +- [GiftCardService](../classes/admin_discounts.internal.internal.GiftCardService.mdx) +- [IAdminPostUploadsFileReq](../classes/admin_discounts.internal.internal.IAdminPostUploadsFileReq.mdx) +- [IdempotencyKey](../classes/admin_discounts.internal.internal.IdempotencyKey.mdx) +- [IdempotencyKeyService](../classes/admin_discounts.internal.internal.IdempotencyKeyService.mdx) +- [Invite](../classes/admin_discounts.internal.internal.Invite.mdx) +- [Item](../classes/admin_discounts.internal.internal.Item.mdx) +- [LineItemAdjustmentService](../classes/admin_discounts.internal.internal.LineItemAdjustmentService.mdx) +- [LineItemService](../classes/admin_discounts.internal.internal.LineItemService.mdx) +- [MiddlewareService](../classes/admin_discounts.internal.internal.MiddlewareService.mdx) +- [NewTotalsService](../classes/admin_discounts.internal.internal.NewTotalsService.mdx) +- [Note](../classes/admin_discounts.internal.internal.Note.mdx) +- [NoteService](../classes/admin_discounts.internal.internal.NoteService.mdx) +- [Notification](../classes/admin_discounts.internal.internal.Notification.mdx) +- [NotificationService](../classes/admin_discounts.internal.internal.NotificationService.mdx) +- [NumericalComparisonOperator](../classes/admin_discounts.internal.internal.NumericalComparisonOperator.mdx) +- [Oauth](../classes/admin_discounts.internal.internal.Oauth.mdx) +- [OauthService](../classes/admin_discounts.internal.internal.OauthService.mdx) +- [OrderEditItemChangeService](../classes/admin_discounts.internal.internal.OrderEditItemChangeService.mdx) +- [OrderEditService](../classes/admin_discounts.internal.internal.OrderEditService.mdx) +- [OrderService](../classes/admin_discounts.internal.internal.OrderService.mdx) +- [PaymentCollectionService](../classes/admin_discounts.internal.internal.PaymentCollectionService.mdx) +- [PaymentProviderService](../classes/admin_discounts.internal.internal.PaymentProviderService.mdx) +- [PriceListService](../classes/admin_discounts.internal.internal.PriceListService.mdx) +- [PricingService](../classes/admin_discounts.internal.internal.PricingService.mdx) +- [ProductCategoryService](../classes/admin_discounts.internal.internal.ProductCategoryService.mdx) +- [ProductCollectionService](../classes/admin_discounts.internal.internal.ProductCollectionService.mdx) +- [ProductService](../classes/admin_discounts.internal.internal.ProductService.mdx) +- [ProductTaxRate](../classes/admin_discounts.internal.internal.ProductTaxRate.mdx) +- [ProductTypeService](../classes/admin_discounts.internal.internal.ProductTypeService.mdx) +- [ProductTypeTaxRate](../classes/admin_discounts.internal.internal.ProductTypeTaxRate.mdx) +- [ProductVariantInventoryService](../classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx) +- [ProductVariantMoneyAmount](../classes/admin_discounts.internal.internal.ProductVariantMoneyAmount.mdx) +- [ProductVariantService](../classes/admin_discounts.internal.internal.ProductVariantService.mdx) +- [PublishableApiKey](../classes/admin_discounts.internal.internal.PublishableApiKey.mdx) +- [PublishableApiKeySalesChannel](../classes/admin_discounts.internal.internal.PublishableApiKeySalesChannel.mdx) +- [RegionService](../classes/admin_discounts.internal.internal.RegionService.mdx) +- [ReturnReasonService](../classes/admin_discounts.internal.internal.ReturnReasonService.mdx) +- [ReturnService](../classes/admin_discounts.internal.internal.ReturnService.mdx) +- [SalesChannelInventoryService](../classes/admin_discounts.internal.internal.SalesChannelInventoryService.mdx) +- [SalesChannelLocationService](../classes/admin_discounts.internal.internal.SalesChannelLocationService.mdx) +- [SalesChannelService](../classes/admin_discounts.internal.internal.SalesChannelService.mdx) +- [SearchService](../classes/admin_discounts.internal.internal.SearchService.mdx) +- [ShippingAddressPayload](../classes/admin_discounts.internal.internal.ShippingAddressPayload.mdx) +- [ShippingOptionService](../classes/admin_discounts.internal.internal.ShippingOptionService.mdx) +- [ShippingProfileService](../classes/admin_discounts.internal.internal.ShippingProfileService.mdx) +- [ShippingTaxRate](../classes/admin_discounts.internal.internal.ShippingTaxRate.mdx) +- [StagedJob](../classes/admin_discounts.internal.internal.StagedJob.mdx) +- [StagedJobService](../classes/admin_discounts.internal.internal.StagedJobService.mdx) +- [Store](../classes/admin_discounts.internal.internal.Store.mdx) +- [StoreGetCollectionsParams](../classes/admin_discounts.internal.internal.StoreGetCollectionsParams.mdx) +- [StoreGetCustomersCustomerOrdersPaginationParams](../classes/admin_discounts.internal.internal.StoreGetCustomersCustomerOrdersPaginationParams.mdx) +- [StoreGetCustomersCustomerOrdersParams](../classes/admin_discounts.internal.internal.StoreGetCustomersCustomerOrdersParams.mdx) +- [StoreGetOrdersParams](../classes/admin_discounts.internal.internal.StoreGetOrdersParams.mdx) +- [StoreGetPaymentCollectionsParams](../classes/admin_discounts.internal.internal.StoreGetPaymentCollectionsParams.mdx) +- [StoreGetProductCategoriesCategoryParams](../classes/admin_discounts.internal.internal.StoreGetProductCategoriesCategoryParams.mdx) +- [StoreGetProductCategoriesParams](../classes/admin_discounts.internal.internal.StoreGetProductCategoriesParams.mdx) +- [StoreGetProductTagsParams](../classes/admin_discounts.internal.internal.StoreGetProductTagsParams.mdx) +- [StoreGetProductTypesParams](../classes/admin_discounts.internal.internal.StoreGetProductTypesParams.mdx) +- [StoreGetProductsPaginationParams](../classes/admin_discounts.internal.internal.StoreGetProductsPaginationParams.mdx) +- [StoreGetProductsParams](../classes/admin_discounts.internal.internal.StoreGetProductsParams.mdx) +- [StoreGetRegionsParams](../classes/admin_discounts.internal.internal.StoreGetRegionsParams.mdx) +- [StoreGetShippingOptionsParams](../classes/admin_discounts.internal.internal.StoreGetShippingOptionsParams.mdx) +- [StoreGetVariantsParams](../classes/admin_discounts.internal.internal.StoreGetVariantsParams.mdx) +- [StoreGetVariantsVariantParams](../classes/admin_discounts.internal.internal.StoreGetVariantsVariantParams.mdx) +- [StorePaymentCollectionSessionsReq](../classes/admin_discounts.internal.internal.StorePaymentCollectionSessionsReq.mdx) +- [StorePostAuthReq](../classes/admin_discounts.internal.internal.StorePostAuthReq.mdx) +- [StorePostCartReq](../classes/admin_discounts.internal.internal.StorePostCartReq.mdx) +- [StorePostCartsCartLineItemsItemReq](../classes/admin_discounts.internal.internal.StorePostCartsCartLineItemsItemReq.mdx) +- [StorePostCartsCartLineItemsReq](../classes/admin_discounts.internal.internal.StorePostCartsCartLineItemsReq.mdx) +- [StorePostCartsCartPaymentSessionReq](../classes/admin_discounts.internal.internal.StorePostCartsCartPaymentSessionReq.mdx) +- [StorePostCartsCartPaymentSessionUpdateReq](../classes/admin_discounts.internal.internal.StorePostCartsCartPaymentSessionUpdateReq.mdx) +- [StorePostCartsCartReq](../classes/admin_discounts.internal.internal.StorePostCartsCartReq.mdx) +- [StorePostCartsCartShippingMethodReq](../classes/admin_discounts.internal.internal.StorePostCartsCartShippingMethodReq.mdx) +- [StorePostCustomersCustomerAcceptClaimReq](../classes/admin_discounts.internal.internal.StorePostCustomersCustomerAcceptClaimReq.mdx) +- [StorePostCustomersCustomerOrderClaimReq](../classes/admin_discounts.internal.internal.StorePostCustomersCustomerOrderClaimReq.mdx) +- [StorePostCustomersCustomerPasswordTokenReq](../classes/admin_discounts.internal.internal.StorePostCustomersCustomerPasswordTokenReq.mdx) +- [StorePostCustomersCustomerReq](../classes/admin_discounts.internal.internal.StorePostCustomersCustomerReq.mdx) +- [StorePostCustomersReq](../classes/admin_discounts.internal.internal.StorePostCustomersReq.mdx) +- [StorePostCustomersResetPasswordReq](../classes/admin_discounts.internal.internal.StorePostCustomersResetPasswordReq.mdx) +- [StorePostOrderEditsOrderEditDecline](../classes/admin_discounts.internal.internal.StorePostOrderEditsOrderEditDecline.mdx) +- [StorePostPaymentCollectionsBatchSessionsAuthorizeReq](../classes/admin_discounts.internal.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.mdx) +- [StorePostPaymentCollectionsBatchSessionsReq](../classes/admin_discounts.internal.internal.StorePostPaymentCollectionsBatchSessionsReq.mdx) +- [StorePostPaymentCollectionsSessionsReq](../classes/admin_discounts.internal.internal.StorePostPaymentCollectionsSessionsReq.mdx) +- [StorePostReturnsReq](../classes/admin_discounts.internal.internal.StorePostReturnsReq.mdx) +- [StorePostSearchReq](../classes/admin_discounts.internal.internal.StorePostSearchReq.mdx) +- [StorePostSwapsReq](../classes/admin_discounts.internal.internal.StorePostSwapsReq.mdx) +- [StoreService](../classes/admin_discounts.internal.internal.StoreService.mdx) +- [StrategyResolverService](../classes/admin_discounts.internal.internal.StrategyResolverService.mdx) +- [SwapService](../classes/admin_discounts.internal.internal.SwapService.mdx) +- [SystemPaymentProviderService](../classes/admin_discounts.internal.internal.SystemPaymentProviderService.mdx) +- [TaxProviderService](../classes/admin_discounts.internal.internal.TaxProviderService.mdx) +- [TaxRateService](../classes/admin_discounts.internal.internal.TaxRateService.mdx) +- [TokenService](../classes/admin_discounts.internal.internal.TokenService.mdx) +- [TotalsService](../classes/admin_discounts.internal.internal.TotalsService.mdx) +- [TransactionBaseService](../classes/admin_discounts.internal.internal.TransactionBaseService.mdx) +- [UserService](../classes/admin_discounts.internal.internal.UserService.mdx) + +## Interfaces + +- [CustomFindOptions](../interfaces/admin_discounts.internal.internal.CustomFindOptions.mdx) +- [FindConfig](../interfaces/admin_discounts.internal.internal.FindConfig.mdx) +- [FulfillmentService](../interfaces/admin_discounts.internal.internal.FulfillmentService.mdx) +- [IBatchJobStrategy](../interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx) +- [ICartCompletionStrategy](../interfaces/admin_discounts.internal.internal.ICartCompletionStrategy.mdx) +- [IFileService](../interfaces/admin_discounts.internal.internal.IFileService.mdx) +- [INotificationService](../interfaces/admin_discounts.internal.internal.INotificationService.mdx) +- [IPriceSelectionStrategy](../interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx) +- [ITaxCalculationStrategy](../interfaces/admin_discounts.internal.internal.ITaxCalculationStrategy.mdx) +- [ITaxService](../interfaces/admin_discounts.internal.internal.ITaxService.mdx) +- [PaymentProcessor](../interfaces/admin_discounts.internal.internal.PaymentProcessor.mdx) +- [PaymentProcessorError](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) +- [PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx) + +## References + +### Address + +Re-exports [Address](../classes/admin_collections.internal.Address.mdx) + +___ + +### AddressCreatePayload + +Re-exports [AddressCreatePayload](../classes/addresses.internal.AddressCreatePayload.mdx) + +___ + +### AddressPayload + +Re-exports [AddressPayload](../classes/addresses.internal.AddressPayload.mdx) + +___ + +### AdminAuthRes + +Re-exports [AdminAuthRes](../../admin_auth/modules/admin_auth.internal.mdx#adminauthres) + +___ + +### AdminBatchJobListRes + +Re-exports [AdminBatchJobListRes](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#adminbatchjoblistres) + +___ + +### AdminBatchJobRes + +Re-exports [AdminBatchJobRes](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#adminbatchjobres) + +___ + +### AdminBearerAuthRes + +Re-exports [AdminBearerAuthRes](../../admin_auth/modules/admin_auth.internal.mdx#adminbearerauthres) + +___ + +### AdminCollectionsListRes + +Re-exports [AdminCollectionsListRes](../../admin_collections/modules/admin_collections.internal.mdx#admincollectionslistres) + +___ + +### AdminCollectionsRes + +Re-exports [AdminCollectionsRes](../../admin_collections/modules/admin_collections.internal.mdx#admincollectionsres) + +___ + +### AdminCreateCondition + +Re-exports [AdminCreateCondition](../classes/admin_discounts.internal.AdminCreateCondition.mdx) + +___ + +### AdminCurrenciesListRes + +Re-exports [AdminCurrenciesListRes](../../admin_currencies/modules/admin_currencies.internal.mdx#admincurrencieslistres) + +___ + +### AdminCurrenciesRes + +Re-exports [AdminCurrenciesRes](../../admin_currencies/modules/admin_currencies.internal.mdx#admincurrenciesres) + +___ + +### AdminCustomerGroupsListRes + +Re-exports [AdminCustomerGroupsListRes](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx#admincustomergroupslistres) + +___ + +### AdminCustomerGroupsRes + +Re-exports [AdminCustomerGroupsRes](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx#admincustomergroupsres) + +___ + +### AdminCustomersListRes + +Re-exports [AdminCustomersListRes](../../admin_customers/modules/admin_customers.internal.mdx#admincustomerslistres) + +___ + +### AdminCustomersRes + +Re-exports [AdminCustomersRes](../../admin_customers/modules/admin_customers.internal.mdx#admincustomersres) + +___ + +### AdminDeleteCustomerGroupsGroupCustomerBatchReq + +Re-exports [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../classes/admin_customer_groups.internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.mdx) + +___ + +### AdminDeleteDiscountsDiscountConditionsConditionBatchReq + +Re-exports [AdminDeleteDiscountsDiscountConditionsConditionBatchReq](../classes/admin_discounts.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.mdx) + +___ + +### AdminDeleteProductsFromCollectionReq + +Re-exports [AdminDeleteProductsFromCollectionReq](../classes/admin_collections.internal.AdminDeleteProductsFromCollectionReq.mdx) + +___ + +### AdminDeleteProductsFromCollectionRes + +Re-exports [AdminDeleteProductsFromCollectionRes](../../admin_collections/modules/admin_collections.internal.mdx#admindeleteproductsfromcollectionres) + +___ + +### AdminDiscountConditionsRes + +Re-exports [AdminDiscountConditionsRes](../../admin_discounts/modules/admin_discounts.internal.mdx#admindiscountconditionsres) + +___ + +### AdminDiscountsListRes + +Re-exports [AdminDiscountsListRes](../../admin_discounts/modules/admin_discounts.internal.mdx#admindiscountslistres) + +___ + +### AdminDiscountsRes + +Re-exports [AdminDiscountsRes](../../admin_discounts/modules/admin_discounts.internal.mdx#admindiscountsres) + +___ + +### AdminGetBatchPaginationParams + +Re-exports [AdminGetBatchPaginationParams](../classes/admin_batch_jobs.internal.AdminGetBatchPaginationParams.mdx) + +___ + +### AdminGetBatchParams + +Re-exports [AdminGetBatchParams](../classes/admin_batch_jobs.internal.AdminGetBatchParams.mdx) + +___ + +### AdminGetCollectionsPaginationParams + +Re-exports [AdminGetCollectionsPaginationParams](../classes/admin_collections.internal.AdminGetCollectionsPaginationParams.mdx) + +___ + +### AdminGetCollectionsParams + +Re-exports [AdminGetCollectionsParams](../classes/admin_collections.internal.AdminGetCollectionsParams.mdx) + +___ + +### AdminGetCurrenciesParams + +Re-exports [AdminGetCurrenciesParams](../classes/admin_currencies.internal.AdminGetCurrenciesParams.mdx) + +___ + +### AdminGetCustomerGroupsGroupParams + +Re-exports [AdminGetCustomerGroupsGroupParams](../classes/admin_customer_groups.internal.AdminGetCustomerGroupsGroupParams.mdx) + +___ + +### AdminGetCustomerGroupsParams + +Re-exports [AdminGetCustomerGroupsParams](../classes/admin_customer_groups.internal.AdminGetCustomerGroupsParams.mdx) + +___ + +### AdminGetCustomersParams + +Re-exports [AdminGetCustomersParams](../classes/admin_customers.internal.AdminGetCustomersParams.mdx) + +___ + +### AdminGetDiscountsDiscountConditionsConditionParams + +Re-exports [AdminGetDiscountsDiscountConditionsConditionParams](../classes/admin_discounts.internal.AdminGetDiscountsDiscountConditionsConditionParams.mdx) + +___ + +### AdminGetDiscountsParams + +Re-exports [AdminGetDiscountsParams](../classes/admin_discounts.internal.AdminGetDiscountsParams.mdx) + +___ + +### AdminPostAuthReq + +Re-exports [AdminPostAuthReq](../classes/admin_auth.internal.AdminPostAuthReq.mdx) + +___ + +### AdminPostBatchesReq + +Re-exports [AdminPostBatchesReq](../classes/admin_batch_jobs.internal.AdminPostBatchesReq.mdx) + +___ + +### AdminPostCollectionsCollectionReq + +Re-exports [AdminPostCollectionsCollectionReq](../classes/admin_collections.internal.AdminPostCollectionsCollectionReq.mdx) + +___ + +### AdminPostCollectionsReq + +Re-exports [AdminPostCollectionsReq](../classes/admin_collections.internal.AdminPostCollectionsReq.mdx) + +___ + +### AdminPostCurrenciesCurrencyReq + +Re-exports [AdminPostCurrenciesCurrencyReq](../classes/admin_currencies.internal.AdminPostCurrenciesCurrencyReq.mdx) + +___ + +### AdminPostCustomerGroupsGroupCustomersBatchReq + +Re-exports [AdminPostCustomerGroupsGroupCustomersBatchReq](../classes/admin_customer_groups.internal.AdminPostCustomerGroupsGroupCustomersBatchReq.mdx) + +___ + +### AdminPostCustomerGroupsGroupReq + +Re-exports [AdminPostCustomerGroupsGroupReq](../classes/admin_customer_groups.internal.AdminPostCustomerGroupsGroupReq.mdx) + +___ + +### AdminPostCustomerGroupsReq + +Re-exports [AdminPostCustomerGroupsReq](../classes/admin_customer_groups.internal.AdminPostCustomerGroupsReq.mdx) + +___ + +### AdminPostCustomersCustomerReq + +Re-exports [AdminPostCustomersCustomerReq](../classes/admin_customers.internal.AdminPostCustomersCustomerReq.mdx) + +___ + +### AdminPostCustomersReq + +Re-exports [AdminPostCustomersReq](../classes/admin_customers.internal.AdminPostCustomersReq.mdx) + +___ + +### AdminPostDiscountsDiscountConditions + +Re-exports [AdminPostDiscountsDiscountConditions](../classes/admin_discounts.internal.AdminPostDiscountsDiscountConditions.mdx) + +___ + +### AdminPostDiscountsDiscountConditionsCondition + +Re-exports [AdminPostDiscountsDiscountConditionsCondition](../classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsCondition.mdx) + +___ + +### AdminPostDiscountsDiscountConditionsConditionBatchParams + +Re-exports [AdminPostDiscountsDiscountConditionsConditionBatchParams](../classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionBatchParams.mdx) + +___ + +### AdminPostDiscountsDiscountConditionsConditionBatchReq + +Re-exports [AdminPostDiscountsDiscountConditionsConditionBatchReq](../classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionBatchReq.mdx) + +___ + +### AdminPostDiscountsDiscountConditionsConditionParams + +Re-exports [AdminPostDiscountsDiscountConditionsConditionParams](../classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsConditionParams.mdx) + +___ + +### AdminPostDiscountsDiscountConditionsParams + +Re-exports [AdminPostDiscountsDiscountConditionsParams](../classes/admin_discounts.internal.AdminPostDiscountsDiscountConditionsParams.mdx) + +___ + +### AdminPostDiscountsDiscountDynamicCodesReq + +Re-exports [AdminPostDiscountsDiscountDynamicCodesReq](../classes/admin_discounts.internal.AdminPostDiscountsDiscountDynamicCodesReq.mdx) + +___ + +### AdminPostDiscountsDiscountReq + +Re-exports [AdminPostDiscountsDiscountReq](../classes/admin_discounts.internal.AdminPostDiscountsDiscountReq.mdx) + +___ + +### AdminPostDiscountsDiscountRule + +Re-exports [AdminPostDiscountsDiscountRule](../classes/admin_discounts.internal.AdminPostDiscountsDiscountRule.mdx) + +___ + +### AdminPostDiscountsReq + +Re-exports [AdminPostDiscountsReq](../classes/admin_discounts.internal.AdminPostDiscountsReq.mdx) + +___ + +### AdminPostProductsToCollectionReq + +Re-exports [AdminPostProductsToCollectionReq](../classes/admin_collections.internal.AdminPostProductsToCollectionReq.mdx) + +___ + +### AdminUpdateDiscountRule + +Re-exports [AdminUpdateDiscountRule](../classes/admin_discounts.internal.AdminUpdateDiscountRule.mdx) + +___ + +### AdminUpsertCondition + +Re-exports [AdminUpsertCondition](../classes/admin_discounts.internal.AdminUpsertCondition.mdx) + +___ + +### AllocationType + +Re-exports [AllocationType](../enums/admin_collections.internal.AllocationType.mdx) + +___ + +### BaseEntity + +Re-exports [BaseEntity](../classes/admin_auth.internal.BaseEntity.mdx) + +___ + +### BatchJob + +Re-exports [BatchJob](../classes/admin_batch_jobs.internal.BatchJob.mdx) + +___ + +### BatchJobResultError + +Re-exports [BatchJobResultError](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#batchjobresulterror) + +___ + +### BatchJobResultStatDescriptor + +Re-exports [BatchJobResultStatDescriptor](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#batchjobresultstatdescriptor) + +___ + +### BatchJobStatus + +Re-exports [BatchJobStatus](../enums/admin_batch_jobs.internal.BatchJobStatus.mdx) + +___ + +### Cart + +Re-exports [Cart](../classes/admin_collections.internal.Cart.mdx) + +___ + +### CartType + +Re-exports [CartType](../enums/admin_collections.internal.CartType.mdx) + +___ + +### ClaimFulfillmentStatus + +Re-exports [ClaimFulfillmentStatus](../enums/admin_collections.internal.ClaimFulfillmentStatus.mdx) + +___ + +### ClaimImage + +Re-exports [ClaimImage](../classes/admin_collections.internal.ClaimImage.mdx) + +___ + +### ClaimItem + +Re-exports [ClaimItem](../classes/admin_collections.internal.ClaimItem.mdx) + +___ + +### ClaimOrder + +Re-exports [ClaimOrder](../classes/admin_collections.internal.ClaimOrder.mdx) + +___ + +### ClaimPaymentStatus + +Re-exports [ClaimPaymentStatus](../enums/admin_collections.internal.ClaimPaymentStatus.mdx) + +___ + +### ClaimReason + +Re-exports [ClaimReason](../enums/admin_collections.internal.ClaimReason.mdx) + +___ + +### ClaimTag + +Re-exports [ClaimTag](../classes/admin_collections.internal.ClaimTag.mdx) + +___ + +### ClaimType + +Re-exports [ClaimType](../enums/admin_collections.internal.ClaimType.mdx) + +___ + +### Country + +Re-exports [Country](../classes/admin_collections.internal.Country.mdx) + +___ + +### Currency + +Re-exports [Currency](../classes/admin_collections.internal.Currency.mdx) + +___ + +### Customer + +Re-exports [Customer](../classes/admin_collections.internal.Customer.mdx) + +___ + +### CustomerGroup + +Re-exports [CustomerGroup](../classes/admin_collections.internal.CustomerGroup.mdx) + +___ + +### DateComparisonOperator + +Re-exports [DateComparisonOperator](../classes/admin_batch_jobs.internal.DateComparisonOperator.mdx) + +___ + +### Discount + +Re-exports [Discount](../classes/admin_collections.internal.Discount.mdx) + +___ + +### DiscountCondition + +Re-exports [DiscountCondition](../classes/admin_collections.internal.DiscountCondition.mdx) + +___ + +### DiscountConditionOperator + +Re-exports [DiscountConditionOperator](../enums/admin_collections.internal.DiscountConditionOperator.mdx) + +___ + +### DiscountConditionType + +Re-exports [DiscountConditionType](../enums/admin_collections.internal.DiscountConditionType.mdx) + +___ + +### DiscountRule + +Re-exports [DiscountRule](../classes/admin_collections.internal.DiscountRule.mdx) + +___ + +### DiscountRuleType + +Re-exports [DiscountRuleType](../enums/admin_collections.internal.DiscountRuleType.mdx) + +___ + +### DraftOrder + +Re-exports [DraftOrder](../classes/admin_collections.internal.DraftOrder.mdx) + +___ + +### DraftOrderStatus + +Re-exports [DraftOrderStatus](../enums/admin_collections.internal.DraftOrderStatus.mdx) + +___ + +### FindPaginationParams + +Re-exports [FindPaginationParams](../classes/admin_currencies.internal.FindPaginationParams.mdx) + +___ + +### FindParams + +Re-exports [FindParams](../classes/admin_customer_groups.internal.FindParams.mdx) + +___ + +### Fulfillment + +Re-exports [Fulfillment](../classes/admin_collections.internal.Fulfillment.mdx) + +___ + +### FulfillmentItem + +Re-exports [FulfillmentItem](../classes/admin_collections.internal.FulfillmentItem.mdx) + +___ + +### FulfillmentProvider + +Re-exports [FulfillmentProvider](../classes/admin_collections.internal.FulfillmentProvider.mdx) + +___ + +### FulfillmentStatus + +Re-exports [FulfillmentStatus](../enums/admin_collections.internal.FulfillmentStatus.mdx) + +___ + +### GiftCard + +Re-exports [GiftCard](../classes/admin_collections.internal.GiftCard.mdx) + +___ + +### GiftCardTransaction + +Re-exports [GiftCardTransaction](../classes/admin_collections.internal.GiftCardTransaction.mdx) + +___ + +### Image + +Re-exports [Image](../classes/admin_collections.internal.Image.mdx) + +___ + +### LineItem + +Re-exports [LineItem](../classes/admin_collections.internal.LineItem.mdx) + +___ + +### LineItemAdjustment + +Re-exports [LineItemAdjustment](../classes/admin_collections.internal.LineItemAdjustment.mdx) + +___ + +### LineItemTaxLine + +Re-exports [LineItemTaxLine](../classes/admin_collections.internal.LineItemTaxLine.mdx) + +___ + +### MoneyAmount + +Re-exports [MoneyAmount](../classes/admin_collections.internal.MoneyAmount.mdx) + +___ + +### Order + +Re-exports [Order](../classes/admin_collections.internal.Order.mdx) + +___ + +### OrderEdit + +Re-exports [OrderEdit](../classes/admin_collections.internal.OrderEdit.mdx) + +___ + +### OrderEditItemChangeType + +Re-exports [OrderEditItemChangeType](../enums/admin_collections.internal.OrderEditItemChangeType.mdx) + +___ + +### OrderEditStatus + +Re-exports [OrderEditStatus](../enums/admin_collections.internal.OrderEditStatus.mdx) + +___ + +### OrderItemChange + +Re-exports [OrderItemChange](../classes/admin_collections.internal.OrderItemChange.mdx) + +___ + +### OrderStatus + +Re-exports [OrderStatus](../enums/admin_collections.internal.OrderStatus.mdx) + +___ + +### PaginatedResponse + +Re-exports [PaginatedResponse](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) + +___ + +### Payment + +Re-exports [Payment](../classes/admin_collections.internal.Payment.mdx) + +___ + +### PaymentCollection + +Re-exports [PaymentCollection](../classes/admin_collections.internal.PaymentCollection.mdx) + +___ + +### PaymentCollectionStatus + +Re-exports [PaymentCollectionStatus](../enums/admin_collections.internal.PaymentCollectionStatus.mdx) + +___ + +### PaymentProvider + +Re-exports [PaymentProvider](../classes/admin_collections.internal.PaymentProvider.mdx) + +___ + +### PaymentSession + +Re-exports [PaymentSession](../classes/admin_collections.internal.PaymentSession.mdx) + +___ + +### PaymentStatus + +Re-exports [PaymentStatus](../enums/admin_collections.internal.PaymentStatus.mdx) + +___ + +### PriceList + +Re-exports [PriceList](../classes/admin_collections.internal.PriceList.mdx) + +___ + +### PriceListStatus + +Re-exports [PriceListStatus](../enums/admin_collections.internal.PriceListStatus.mdx) + +___ + +### PriceListType + +Re-exports [PriceListType](../enums/admin_collections.internal.PriceListType.mdx) + +___ + +### Product + +Re-exports [Product](../classes/admin_collections.internal.Product.mdx) + +___ + +### ProductCategory + +Re-exports [ProductCategory](../classes/admin_collections.internal.ProductCategory.mdx) + +___ + +### ProductCollection + +Re-exports [ProductCollection](../classes/admin_collections.internal.ProductCollection.mdx) + +___ + +### ProductOption + +Re-exports [ProductOption](../classes/admin_collections.internal.ProductOption.mdx) + +___ + +### ProductOptionValue + +Re-exports [ProductOptionValue](../classes/admin_collections.internal.ProductOptionValue.mdx) + +___ + +### ProductStatus + +Re-exports [ProductStatus](../enums/admin_collections.internal.ProductStatus.mdx) + +___ + +### ProductTag + +Re-exports [ProductTag](../classes/admin_collections.internal.ProductTag.mdx) + +___ + +### ProductType + +Re-exports [ProductType](../classes/admin_collections.internal.ProductType.mdx) + +___ + +### ProductVariant + +Re-exports [ProductVariant](../classes/admin_collections.internal.ProductVariant.mdx) + +___ + +### ProductVariantInventoryItem + +Re-exports [ProductVariantInventoryItem](../classes/admin_collections.internal.ProductVariantInventoryItem.mdx) + +___ + +### Refund + +Re-exports [Refund](../classes/admin_collections.internal.Refund.mdx) + +___ + +### Region + +Re-exports [Region](../classes/admin_collections.internal.Region.mdx) + +___ + +### RequirementType + +Re-exports [RequirementType](../enums/admin_collections.internal.RequirementType.mdx) + +___ + +### Return + +Re-exports [Return](../classes/admin_collections.internal.Return.mdx) + +___ + +### ReturnItem + +Re-exports [ReturnItem](../classes/admin_collections.internal.ReturnItem.mdx) + +___ + +### ReturnReason + +Re-exports [ReturnReason](../classes/admin_collections.internal.ReturnReason.mdx) + +___ + +### ReturnStatus + +Re-exports [ReturnStatus](../enums/admin_collections.internal.ReturnStatus.mdx) + +___ + +### SalesChannel + +Re-exports [SalesChannel](../classes/admin_collections.internal.SalesChannel.mdx) + +___ + +### SalesChannelLocation + +Re-exports [SalesChannelLocation](../classes/admin_collections.internal.SalesChannelLocation.mdx) + +___ + +### ShippingMethod + +Re-exports [ShippingMethod](../classes/admin_collections.internal.ShippingMethod.mdx) + +___ + +### ShippingMethodTaxLine + +Re-exports [ShippingMethodTaxLine](../classes/admin_collections.internal.ShippingMethodTaxLine.mdx) + +___ + +### ShippingOption + +Re-exports [ShippingOption](../classes/admin_collections.internal.ShippingOption.mdx) + +___ + +### ShippingOptionPriceType + +Re-exports [ShippingOptionPriceType](../enums/admin_collections.internal.ShippingOptionPriceType.mdx) + +___ + +### ShippingOptionRequirement + +Re-exports [ShippingOptionRequirement](../classes/admin_collections.internal.ShippingOptionRequirement.mdx) + +___ + +### ShippingProfile + +Re-exports [ShippingProfile](../classes/admin_collections.internal.ShippingProfile.mdx) + +___ + +### ShippingProfileType + +Re-exports [ShippingProfileType](../enums/admin_collections.internal.ShippingProfileType.mdx) + +___ + +### SoftDeletableEntity + +Re-exports [SoftDeletableEntity](../classes/admin_auth.internal.SoftDeletableEntity.mdx) + +___ + +### StorePostCustomersCustomerAddressesAddressReq + +Re-exports [StorePostCustomersCustomerAddressesAddressReq](../classes/addresses.internal.StorePostCustomersCustomerAddressesAddressReq.mdx) + +___ + +### StorePostCustomersCustomerAddressesReq + +Re-exports [StorePostCustomersCustomerAddressesReq](../classes/addresses.internal.StorePostCustomersCustomerAddressesReq.mdx) + +___ + +### StringComparisonOperator + +Re-exports [StringComparisonOperator](../classes/admin_customer_groups.internal.StringComparisonOperator.mdx) + +___ + +### Swap + +Re-exports [Swap](../classes/admin_collections.internal.Swap.mdx) + +___ + +### SwapFulfillmentStatus + +Re-exports [SwapFulfillmentStatus](../enums/admin_collections.internal.SwapFulfillmentStatus.mdx) + +___ + +### SwapPaymentStatus + +Re-exports [SwapPaymentStatus](../enums/admin_collections.internal.SwapPaymentStatus.mdx) + +___ + +### TaxProvider + +Re-exports [TaxProvider](../classes/admin_collections.internal.TaxProvider.mdx) + +___ + +### TaxRate + +Re-exports [TaxRate](../classes/admin_collections.internal.TaxRate.mdx) + +___ + +### TrackingLink + +Re-exports [TrackingLink](../classes/admin_collections.internal.TrackingLink.mdx) + +___ + +### User + +Re-exports [User](../classes/admin_auth.internal.User.mdx) + +___ + +### UserRoles + +Re-exports [UserRoles](../enums/admin_auth.internal.UserRoles.mdx) + +## Type Aliases + +### AdminAnalyticsConfigDeleteRes + +Ƭ **AdminAnalyticsConfigDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + +___ + +### AdminAnalyticsConfigRes + +Ƭ **AdminAnalyticsConfigRes**: `Object` + +#### Type declaration + + + +___ + +### AdminCollectionsDeleteRes + +Ƭ **AdminCollectionsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminCustomerGroupsDeleteRes + +Ƭ **AdminCustomerGroupsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminDeleteShippingProfileRes + +Ƭ **AdminDeleteShippingProfileRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminDeleteUploadsRes + +Ƭ **AdminDeleteUploadsRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminDeleteUserRes + +Ƭ **AdminDeleteUserRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminDiscountConditionsDeleteRes + +Ƭ **AdminDiscountConditionsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) & { `discount`: [`Discount`](../classes/admin_collections.internal.Discount.mdx) } + +#### 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" + +___ + +### AdminDiscountsDeleteRes + +Ƭ **AdminDiscountsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminDraftOrdersDeleteRes + +Ƭ **AdminDraftOrdersDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminDraftOrdersListRes + +Ƭ **AdminDraftOrdersListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `draft_orders`: [`DraftOrder`](../classes/admin_collections.internal.DraftOrder.mdx)[] } + +#### 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 + +___ + +### 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 + + + +___ + +### 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 + + + +___ + +### AdminGetVariantsVariantInventoryRes + +Ƭ **AdminGetVariantsVariantInventoryRes**: `Object` + +#### Schema + +The product variant's. + +#### Type declaration + + + +___ + +### AdminGiftCardsDeleteRes + +Ƭ **AdminGiftCardsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminGiftCardsListRes + +Ƭ **AdminGiftCardsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `gift_cards`: [`GiftCard`](../classes/admin_collections.internal.GiftCard.mdx)[] } + +#### 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 + +___ + +### AdminGiftCardsRes + +Ƭ **AdminGiftCardsRes**: `Object` + +#### Schema + +A gift card's details. + +#### Type declaration + + + +___ + +### AdminInventoryItemsDeleteRes + +Ƭ **AdminInventoryItemsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminInventoryItemsListRes + +Ƭ **AdminInventoryItemsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `inventory_items`: [`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + +___ + +### AdminInventoryItemsListWithVariantsAndLocationLevelsRes + +Ƭ **AdminInventoryItemsListWithVariantsAndLocationLevelsRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `inventory_items`: [`DecoratedInventoryItemDTO`](admin_discounts.internal.internal.mdx#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 + +___ + +### 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 + + + +___ + +### AdminInventoryItemsRes + +Ƭ **AdminInventoryItemsRes**: `Object` + +#### Schema + +AdminInventoryItemsRes +type: object +required: + - inventory_item +properties: + inventory_item: + description: Inventory Item details + $ref: "#/components/schemas/InventoryItemDTO" + +#### Type declaration + + + +___ + +### AdminInviteDeleteRes + +Ƭ **AdminInviteDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### 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 + + + +___ + +### AdminNotesDeleteRes + +Ƭ **AdminNotesDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminNotesListRes + +Ƭ **AdminNotesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `notes`: [`Note`](../classes/admin_discounts.internal.internal.Note.mdx)[] } + +#### 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 + +___ + +### AdminNotesRes + +Ƭ **AdminNotesRes**: `Object` + +#### Schema + +AdminNotesRes +type: object +required: + - note +properties: + note: + description: Note details. + $ref: "#/components/schemas/Note" + +#### Type declaration + + + +___ + +### AdminNotificationsListRes + +Ƭ **AdminNotificationsListRes**: [`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `notifications`: [`Notification`](../classes/admin_discounts.internal.internal.Notification.mdx)[] } + +#### 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 + +___ + +### 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 + + + +___ + +### AdminOrderEditDeleteRes + +Ƭ **AdminOrderEditDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### 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 + + + +___ + +### AdminOrderEditsListRes + +Ƭ **AdminOrderEditsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `order_edits`: [`OrderEdit`](../classes/admin_collections.internal.OrderEdit.mdx)[] } + +#### Schema + +An array of order edit details + +___ + +### AdminOrderEditsRes + +Ƭ **AdminOrderEditsRes**: `Object` + +#### Schema + +Order edit details + +#### Type declaration + + + +___ + +### AdminOrdersListRes + +Ƭ **AdminOrdersListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `orders`: [`Order`](../classes/admin_collections.internal.Order.mdx)[] } + +#### Schema + +An array of order details. + +___ + +### AdminOrdersRes + +Ƭ **AdminOrdersRes**: `Object` + +#### Schema + +Order details. + +#### Type declaration + + + +___ + +### 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 + + + +___ + +### 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 + + + +___ + +### 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 + + + +___ + +### AdminPaymentRes + +Ƭ **AdminPaymentRes**: `Object` + +#### Schema + +Payment details + +#### Type declaration + + + +___ + +### AdminPostDraftOrdersDraftOrderRegisterPaymentRes + +Ƭ **AdminPostDraftOrdersDraftOrderRegisterPaymentRes**: `Object` + +#### Schema + +AdminPostDraftOrdersDraftOrderRegisterPaymentRes +type: object +required: + - order +properties: + order: + description: Order's details. + $ref: "#/components/schemas/Order" + +#### Type declaration + + + +___ + +### 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 + + + +___ + +### AdminPriceListDeleteProductPricesRes + +Ƭ **AdminPriceListDeleteProductPricesRes**: [`AdminPriceListDeleteBatchRes`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminPriceListDeleteRes + +Ƭ **AdminPriceListDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminPriceListDeleteVariantPricesRes + +Ƭ **AdminPriceListDeleteVariantPricesRes**: [`AdminPriceListDeleteBatchRes`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminPriceListRes + +Ƭ **AdminPriceListRes**: `Object` + +#### Schema + +Price List details. + +#### Type declaration + + + +___ + +### AdminPriceListsListRes + +Ƭ **AdminPriceListsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/admin_collections.internal.PriceList.mdx)[] } + +#### Schema + +An array of price lists details. + +___ + +### AdminPriceListsProductsListRes + +Ƭ **AdminPriceListsProductsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `products`: [`Product`](../classes/admin_collections.internal.Product.mdx)[] } + +#### Schema + +An array of products details. + +___ + +### AdminProductCategoriesCategoryDeleteRes + +Ƭ **AdminProductCategoriesCategoryDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminProductCategoriesCategoryRes + +Ƭ **AdminProductCategoriesCategoryRes**: `Object` + +#### Schema + +Product category details. + +#### Type declaration + + + +___ + +### AdminProductCategoriesListRes + +Ƭ **AdminProductCategoriesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_categories`: [`ProductCategory`](../classes/admin_collections.internal.ProductCategory.mdx)[] } + +#### Schema + +An array of product category details. + +___ + +### AdminProductTagsListRes + +Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/admin_collections.internal.ProductTag.mdx)[] } + +#### Schema + +An array of product tag details. + +___ + +### AdminProductTypesListRes + +Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_types`: [`ProductType`](../classes/admin_collections.internal.ProductType.mdx)[] } + +#### 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 + +___ + +### 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 + + + +___ + +### 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 + + + +___ + +### 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 + + + +___ + +### AdminProductsListRes + +Ƭ **AdminProductsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `products`: ([`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct) \| [`Product`](../classes/admin_collections.internal.Product.mdx))[] } + +#### 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 + +___ + +### 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 + + & { `usage_count`: `number` }[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### 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 + + + +___ + +### AdminProductsListVariantsRes + +Ƭ **AdminProductsListVariantsRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/admin_collections.internal.ProductVariant.mdx)[] } + +#### 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 + +___ + +### 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 + + + +___ + +### AdminPublishableApiKeyDeleteRes + +Ƭ **AdminPublishableApiKeyDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminPublishableApiKeysListRes + +Ƭ **AdminPublishableApiKeysListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `publishable_api_keys`: [`PublishableApiKey`](../classes/admin_discounts.internal.internal.PublishableApiKey.mdx)[] } + +#### Schema + +An array of publishable API keys details. + +___ + +### AdminPublishableApiKeysListSalesChannelsRes + +Ƭ **AdminPublishableApiKeysListSalesChannelsRes**: `Object` + +#### Schema + +An array of sales channels details. + +#### Type declaration + + + +___ + +### AdminPublishableApiKeysRes + +Ƭ **AdminPublishableApiKeysRes**: `Object` + +#### Schema + +Publishable API key details. + +#### Type declaration + + + +___ + +### AdminRefundRes + +Ƭ **AdminRefundRes**: `Object` + +#### Schema + +Refund details + +#### Type declaration + + + +___ + +### AdminRegionsDeleteRes + +Ƭ **AdminRegionsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminRegionsListRes + +Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `regions`: [`Region`](../classes/admin_collections.internal.Region.mdx)[] } + +#### Schema + +An array of regions details. + +___ + +### AdminReservationsDeleteRes + +Ƭ **AdminReservationsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminReservationsListRes + +Ƭ **AdminReservationsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `reservations`: [`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + +___ + +### AdminReservationsRes + +Ƭ **AdminReservationsRes**: `Object` + +#### Schema + +AdminReservationsRes +type: object +required: + - reservation +properties: + reservation: + description: Reservation details. + $ref: "#/components/schemas/ReservationItemDTO" + +#### Type declaration + + + +___ + +### AdminReturnReasonsDeleteRes + +Ƭ **AdminReturnReasonsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### 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 + + + +___ + +### 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 + + + +___ + +### 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 + + + +___ + +### AdminReturnsListRes + +Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `returns`: [`Return`](../classes/admin_collections.internal.Return.mdx)[] } + +#### 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 + +___ + +### 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 + + + +___ + +### AdminSalesChannelsDeleteLocationRes + +Ƭ **AdminSalesChannelsDeleteLocationRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminSalesChannelsDeleteRes + +Ƭ **AdminSalesChannelsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminSalesChannelsListRes + +Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/admin_collections.internal.SalesChannel.mdx)[] } + +#### Schema + +An array of sales channels details. + +___ + +### AdminSalesChannelsRes + +Ƭ **AdminSalesChannelsRes**: `Object` + +#### Schema + +AdminSalesChannelsRes +type: object +required: + - sales_channel +properties: + sales_channel: + description: Sales Channel's details. + $ref: "#/components/schemas/SalesChannel" + +#### Type declaration + + + +___ + +### AdminShippingOptionsDeleteRes + +Ƭ **AdminShippingOptionsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminShippingOptionsListRes + +Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/admin_collections.internal.ShippingOption.mdx)[] } + +#### Schema + +An array of shipping options details. + +___ + +### AdminShippingOptionsRes + +Ƭ **AdminShippingOptionsRes**: `Object` + +#### Schema + +Shipping option details. + +#### Type declaration + + + +___ + +### 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 + + + +___ + +### 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 + + + +___ + +### AdminStockLocationsDeleteRes + +Ƭ **AdminStockLocationsDeleteRes**: [`DeleteResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + +___ + +### AdminStockLocationsListRes + +Ƭ **AdminStockLocationsListRes**: [`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `stock_locations`: [`StockLocationExpandedDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#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 + +___ + +### AdminStockLocationsRes + +Ƭ **AdminStockLocationsRes**: `Object` + +#### Schema + +Stock location details. + +#### Type declaration + + + +___ + +### AdminStoresRes + +Ƭ **AdminStoresRes**: `Object` + +#### Schema + +AdminStoresRes +type: object +required: + - store +properties: + store: + description: Store details. + $ref: "#/components/schemas/Store" + +#### Type declaration + + + +___ + +### AdminSwapsListRes + +Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `swaps`: [`Swap`](../classes/admin_collections.internal.Swap.mdx)[] } + +#### Schema + +An array of swaps details. + +___ + +### AdminSwapsRes + +Ƭ **AdminSwapsRes**: `Object` + +#### Schema + +Swap details. + +#### Type declaration + + + +___ + +### 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 + + + +___ + +### AdminTaxRatesDeleteRes + +Ƭ **AdminTaxRatesDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#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 + +___ + +### AdminTaxRatesListRes + +Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/admin_collections.internal.TaxRate.mdx)[] } + +#### Schema + +An array of tax rate details. + +___ + +### AdminTaxRatesRes + +Ƭ **AdminTaxRatesRes**: `Object` + +#### Schema + +Tax rate details. + +#### Type declaration + + + +___ + +### AdminUploadsDownloadUrlRes + +Ƭ **AdminUploadsDownloadUrlRes**: `Object` + +#### Schema + +AdminUploadsDownloadUrlRes +type: object +required: + - download_url +properties: + download_url: + description: The Download URL of the file + type: string + +#### Type declaration + + + +___ + +### AdminUploadsRes + +Ƭ **AdminUploadsRes**: `Object` + +#### Schema + +Uploaded files details. + +#### Type declaration + + + +___ + +### AdminUserRes + +Ƭ **AdminUserRes**: `Object` + +#### Schema + +User details. + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### AdminUsersListRes + +Ƭ **AdminUsersListRes**: `Object` + +#### Schema + +An array of users details. + +#### Type declaration + +[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### AdminVariantsListRes + +Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `variants`: [`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[] } + +#### Schema + +An array of product variant details. + +___ + +### AdminVariantsRes + +Ƭ **AdminVariantsRes**: `Object` + +#### Schema + +Product variant's details. + +#### Type declaration + + + +___ + +### BatchJobCreateProps + +Ƭ **BatchJobCreateProps**: [`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`BatchJob`](../classes/admin_batch_jobs.internal.BatchJob.mdx), ``"context"`` \| ``"type"`` \| ``"created_by"`` \| ``"dry_run"``\> + +___ + +### BatchJobUpdateProps + +Ƭ **BatchJobUpdateProps**: [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`BatchJob`](../classes/admin_batch_jobs.internal.BatchJob.mdx), ``"context"`` \| ``"result"``\>\> + +___ + +### CartCompletionResponse + +Ƭ **CartCompletionResponse**: `Object` + +#### Type declaration + +", + "description": "The response body for the completion request", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "response_code", + "type": "`number`", + "description": "The response code for the completion request", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### ClassConstructor + +Ƭ **ClassConstructor**<`T`\>: (...`args`: `unknown`[]) => `T` + +#### Type parameters + + + +#### Type declaration + +• **new ClassConstructor**(`...args`): `T` + +##### Parameters + + + +##### Returns + +`T` + + + +___ + +### ConfigModule + +Ƭ **ConfigModule**: [`ConfigModule`](../../admin_discounts/modules/admin_discounts.internal.mdx#configmodule) + +___ + +### Constructor + +Ƭ **Constructor**<`T`\>: `Object` + +#### Type parameters + + + +___ + +### CreateBatchJobInput + +Ƭ **CreateBatchJobInput**: `Object` + +#### Type declaration + + + +___ + +### CreatePriceListInput + +Ƭ **CreatePriceListInput**: `Object` + +#### Type declaration + + + +___ + +### Data + +Ƭ **Data**: Record<`string`, `unknown`\> + +___ + +### DecoratedInventoryItemDTO + +Ƭ **DecoratedInventoryItemDTO**: [`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto) & { `location_levels?`: [`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[] ; `reserved_quantity`: `number` ; `stocked_quantity`: `number` ; `variants?`: [`ProductVariant`](../classes/admin_collections.internal.ProductVariant.mdx)[] } + +#### 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 + +___ + +### DeleteResponse + +Ƭ **DeleteResponse**: `Object` + +#### Type declaration + + + +___ + +### ExtendedFindConfig + +Ƭ **ExtendedFindConfig**<`TEntity`\>: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<`FindOneOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> \| [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#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 + + + +___ + +### ExtendedRequest + +Ƭ **ExtendedRequest**<`TEntity`\>: `Request` & { `resource`: `TEntity` } + +#### Type parameters + + + +___ + +### ExtendedReservationItem + +Ƭ **ExtendedReservationItem**: [`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto) & { `inventory_item?`: [`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto) ; `line_item?`: [`LineItem`](../classes/admin_collections.internal.LineItem.mdx) } + +#### 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" + +___ + +### 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 + + + +___ + +### LevelWithAvailability + +Ƭ **LevelWithAvailability**: [`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto) & { `available_quantity`: `number` } + +___ + +### Logger + +Ƭ **Logger**: `Object` + +#### Type declaration + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "debug", + "type": "(`message`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "error", + "type": "(`messageOrError`: `any`, `error?`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "failure", + "type": "(`activityId`: `any`, `message`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "info", + "type": "(`message`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "log", + "type": "(...`args`: `any`[]) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "panic", + "type": "(`data`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "progress", + "type": "(`activityId`: `any`, `message`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "setLogLevel", + "type": "(`level`: `string`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shouldLog", + "type": "(`level`: `string`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "success", + "type": "(`activityId`: `any`, `message`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "unsetLogLevel", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "warn", + "type": "(`message`: `any`) => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### MedusaContainer + +Ƭ **MedusaContainer**: [`MedusaContainer`](../../admin_discounts/modules/admin_discounts.internal.mdx#medusacontainer-1) + +___ + +### PartialPick + +Ƭ **PartialPick**<`T`, `K`\>: { [P in K]?: T[P] } + +#### Type parameters + + + +___ + +### PaymentContext + +Ƭ **PaymentContext**: `Object` + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart.email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart.id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart.shipping_address", + "type": "[`Address`](../classes/admin_collections.internal.Address.mdx) \\| ``null``", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart.shipping_methods", + "type": "[`ShippingMethod`](../classes/admin_collections.internal.ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](../classes/admin_collections.internal.Customer.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentSessionData", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### PaymentData + +Ƭ **PaymentData**: [`Data`](admin_discounts.internal.internal.mdx#data) + +___ + +### PaymentProcessorContext + +Ƭ **PaymentProcessorContext**: `Object` + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](../classes/admin_collections.internal.Customer.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "paymentSessionData", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### PaymentProcessorSessionResponse + +Ƭ **PaymentProcessorSessionResponse**: `Object` + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "update_requests", + "type": "`object`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "update_requests.customer_metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### PaymentSessionData + +Ƭ **PaymentSessionData**: [`Data`](admin_discounts.internal.internal.mdx#data) + +___ + +### PaymentSessionResponse + +Ƭ **PaymentSessionResponse**: `Object` + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "update_requests", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "update_requests.customer_metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### PriceListLoadConfig + +Ƭ **PriceListLoadConfig**: `Object` + +#### Type declaration + + + +___ + +### PriceListPriceCreateInput + +Ƭ **PriceListPriceCreateInput**: `Object` + +#### Type declaration + + + +___ + +### PriceListPriceUpdateInput + +Ƭ **PriceListPriceUpdateInput**: `Object` + +#### Type declaration + + + +___ + +### PriceSelectionContext + +Ƭ **PriceSelectionContext**: `Object` + +#### Type declaration + + + +___ + +### PriceSelectionResult + +Ƭ **PriceSelectionResult**: `Object` + +#### Type declaration + + + +___ + +### PriceType + +Ƭ **PriceType**: [`DefaultPriceType`](../enums/admin_discounts.internal.DefaultPriceType.mdx) \| [`PriceListType`](../enums/admin_collections.internal.PriceListType.mdx) + +___ + +### QueryConfig + +Ƭ **QueryConfig**<`TEntity`\>: `Object` + +#### Type parameters + + + +#### Type declaration + + + +___ + +### QuerySelector + +Ƭ **QuerySelector**<`TEntity`\>: [`Selector`](admin_discounts.internal.internal.mdx#selector)<`TEntity`\> & { `q?`: `string` } + +#### Type parameters + + + +___ + +### RequestQueryFields + +Ƭ **RequestQueryFields**: `Object` + +#### Type declaration + + + +___ + +### ResponseInventoryItem + +Ƭ **ResponseInventoryItem**: [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> & { `location_levels?`: [`LevelWithAvailability`](admin_discounts.internal.internal.mdx#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 + +___ + +### Selector + +Ƭ **Selector**<`TEntity`\>: { [key in keyof TEntity]?: TEntity[key] \| TEntity[key][] \| DateComparisonOperator \| StringComparisonOperator \| NumericalComparisonOperator \| FindOperator } + +#### Type parameters + + + +___ + +### ShippingTaxCalculationLine + +Ƭ **ShippingTaxCalculationLine**: `Object` + +A shipping method and the tax rates that have been configured to apply to the +shipping method. + +#### Type declaration + + + +___ + +### StoreAuthRes + +Ƭ **StoreAuthRes**: `Object` + +#### Schema + +Customer's details. + +#### Type declaration + + + +___ + +### StoreBearerAuthRes + +Ƭ **StoreBearerAuthRes**: `Object` + +#### Schema + +StoreBearerAuthRes +type: object +properties: + accessToken: + description: Access token for subsequent authorization. + type: string + +#### Type declaration + + + +___ + +### StoreCartShippingOptionsListRes + +Ƭ **StoreCartShippingOptionsListRes**: `Object` + +#### Schema + +An array of shipping options details. + +#### Type declaration + + + +___ + +### StoreCartsRes + +Ƭ **StoreCartsRes**: `Object` + +#### Schema + +Cart details. + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### StoreCollectionsListRes + +Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/admin_collections.internal.ProductCollection.mdx)[] } + +#### Schema + +An array of product collections details + +___ + +### StoreCollectionsRes + +Ƭ **StoreCollectionsRes**: `Object` + +#### Schema + +Product collection details. + +#### Type declaration + + + +___ + +### StoreCompleteCartRes + +Ƭ **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/admin_collections.internal.Cart.mdx) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/admin_collections.internal.Order.mdx) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/admin_collections.internal.Swap.mdx) ; `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" + +___ + +### StoreCustomersListOrdersRes + +Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `orders`: [`Order`](../classes/admin_collections.internal.Order.mdx)[] } + +#### Schema + +An array of orders details. + +___ + +### StoreCustomersListPaymentMethodsRes + +Ƭ **StoreCustomersListPaymentMethodsRes**: `Object` + +#### Schema + +An array of saved payment method details. + +#### Type declaration + + + +___ + +### StoreCustomersRes + +Ƭ **StoreCustomersRes**: `Object` + +#### Schema + +Customer details. + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### StoreCustomersResetPasswordRes + +Ƭ **StoreCustomersResetPasswordRes**: `Object` + +#### Schema + +Customer details. + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### StoreGetAuthEmailRes + +Ƭ **StoreGetAuthEmailRes**: `Object` + +#### Schema + +StoreGetAuthEmailRes +type: object +required: + - exists +properties: + exists: + description: Whether email exists or not. + type: boolean + +#### Type declaration + + + +___ + +### StoreGetProductCategoriesCategoryRes + +Ƭ **StoreGetProductCategoriesCategoryRes**: `Object` + +#### Schema + +Product category details. + +#### Type declaration + + + +___ + +### StoreGetProductCategoriesRes + +Ƭ **StoreGetProductCategoriesRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_categories`: [`ProductCategory`](../classes/admin_collections.internal.ProductCategory.mdx)[] } + +#### Schema + +An array of product categories details. + +___ + +### StoreGiftCardsRes + +Ƭ **StoreGiftCardsRes**: `Object` + +#### Schema + +Gift card details. + +#### Type declaration + + + +___ + +### StoreOrderEditsRes + +Ƭ **StoreOrderEditsRes**: `Object` + +#### Schema + +Order edit details. + +#### Type declaration + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### StoreOrdersRes + +Ƭ **StoreOrdersRes**: `Object` + +#### Schema + +Order details. + +#### Type declaration + + + +___ + +### StorePaymentCollectionsRes + +Ƭ **StorePaymentCollectionsRes**: `Object` + +#### Schema + +Payment collection's details. + +#### Type declaration + + + +___ + +### StorePaymentCollectionsSessionRes + +Ƭ **StorePaymentCollectionsSessionRes**: `Object` + +#### Schema + +Payment session's details. + +#### Type declaration + + + +___ + +### StorePostSearchRes + +Ƭ **StorePostSearchRes**: { `hits`: `unknown`[] } & Record<`string`, `unknown`\> + +#### Schema + +Array of search results. The format of the items depends on the search engine installed on the Medusa backend. + +___ + +### StoreProductTagsListRes + +Ƭ **StoreProductTagsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/admin_collections.internal.ProductTag.mdx)[] } + +#### Schema + +An array of product tags details. + +___ + +### StoreProductTypesListRes + +Ƭ **StoreProductTypesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_types`: [`ProductType`](../classes/admin_collections.internal.ProductType.mdx)[] } + +#### Schema + +An array of product types details. + +___ + +### StoreProductsListRes + +Ƭ **StoreProductsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `products`: [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct)[] } + +#### Schema + +An array of products details. + +___ + +### StoreProductsRes + +Ƭ **StoreProductsRes**: `Object` + +#### Schema + +Product details. + +#### Type declaration + + + +___ + +### StoreRegionsListRes + +Ƭ **StoreRegionsListRes**: [`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `regions`: [`Region`](../classes/admin_collections.internal.Region.mdx)[] } + +#### Schema + +An array of regions details. + +___ + +### StoreRegionsRes + +Ƭ **StoreRegionsRes**: `Object` + +#### Schema + +Region details. + +#### Type declaration + + + +___ + +### StoreReturnReasonsListRes + +Ƭ **StoreReturnReasonsListRes**: `Object` + +#### Schema + +An array of return reasons details. + +#### Type declaration + + + +___ + +### StoreReturnReasonsRes + +Ƭ **StoreReturnReasonsRes**: `Object` + +#### Schema + +Return reason details. + +#### Type declaration + + + +___ + +### StoreReturnsRes + +Ƭ **StoreReturnsRes**: `Object` + +#### Schema + +Return details. + +#### Type declaration + + + +___ + +### StoreShippingOptionsListRes + +Ƭ **StoreShippingOptionsListRes**: `Object` + +#### Schema + +An array of shipping options details. + +#### Type declaration + + + +___ + +### StoreSwapsRes + +Ƭ **StoreSwapsRes**: `Object` + +#### Schema + +Swap details. + +#### Type declaration + + + +___ + +### StoreVariantsListRes + +Ƭ **StoreVariantsListRes**: `Object` + +#### Schema + +An array of product variant descriptions. + +#### Type declaration + + + +___ + +### StoreVariantsRes + +Ƭ **StoreVariantsRes**: `Object` + +#### Schema + +Product variant description. + +#### Type declaration + + + +___ + +### TaxCalculationContext + +Ƭ **TaxCalculationContext**: `Object` + +Information relevant to a tax calculation, such as the shipping address where +the items are going. + +#### Type declaration + + + +___ + +### TotalField + +Ƭ **TotalField**: ``"shipping_total"`` \| ``"discount_total"`` \| ``"tax_total"`` \| ``"refunded_total"`` \| ``"total"`` \| ``"subtotal"`` \| ``"refundable_amount"`` \| ``"gift_card_total"`` \| ``"gift_card_tax_total"`` + +___ + +### TreeQuerySelector + +Ƭ **TreeQuerySelector**<`TEntity`\>: [`QuerySelector`](admin_discounts.internal.internal.mdx#queryselector)<`TEntity`\> & { `include_descendants_tree?`: `boolean` } + +#### Type parameters + + + +___ + +### UpdatePriceListInput + +Ƭ **UpdatePriceListInput**: [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`PriceList`](../classes/admin_collections.internal.PriceList.mdx), ``"name"`` \| ``"description"`` \| ``"starts_at"`` \| ``"ends_at"`` \| ``"status"`` \| ``"type"`` \| ``"includes_tax"``\>\> & { `customer_groups?`: { `id`: `string` }[] ; `prices?`: [`AdminPriceListPricesUpdateReq`](../classes/admin_discounts.internal.internal.AdminPriceListPricesUpdateReq.mdx)[] } + +___ + +### 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 + + + +___ + +### 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 + + + +___ + +### Writable + +Ƭ **Writable**<`T`\>: { -readonly [key in keyof T]: T[key] \| FindOperator \| FindOperator \| FindOperator } + +#### Type parameters + + + +___ + +### payload + +Ƭ **payload**: `Object` + +#### Type declaration + + + +## Variables + +### AvailableOrderIncludes + +• `Const` **AvailableOrderIncludes**: `Object` + +#### Type declaration + + + +___ + +### PriceType + +• **PriceType**: `Object` + +#### Type declaration + + + +___ + +### allowedAdminProductCategoryRelations + +• `Const` **allowedAdminProductCategoryRelations**: `string`[] + +___ + +### allowedFields + +• `Const` **allowedFields**: `string`[] + +___ + +### allowedOrderIncludes + +• `Const` **allowedOrderIncludes**: `string`[] + +___ + +### allowedStoreCustomersFields + +• `Const` **allowedStoreCustomersFields**: `string`[] + +___ + +### allowedStoreCustomersRelations + +• `Const` **allowedStoreCustomersRelations**: `string`[] + +___ + +### allowedStoreGiftCardFields + +• `Const` **allowedStoreGiftCardFields**: `string`[] + +___ + +### allowedStoreGiftCardRelations + +• `Const` **allowedStoreGiftCardRelations**: `string`[] + +___ + +### allowedStoreOrdersFields + +• `Const` **allowedStoreOrdersFields**: `string`[] + +___ + +### allowedStoreOrdersRelations + +• `Const` **allowedStoreOrdersRelations**: `string`[] + +___ + +### allowedStoreProductCategoryFields + +• `Const` **allowedStoreProductCategoryFields**: `string`[] + +___ + +### allowedStoreProductTagFields + +• `Const` **allowedStoreProductTagFields**: `string`[] + +___ + +### allowedStoreProductTypeFields + +• `Const` **allowedStoreProductTypeFields**: `string`[] + +___ + +### allowedStoreProductsFields + +• `Const` **allowedStoreProductsFields**: `string`[] + +___ + +### allowedStoreProductsRelations + +• `Const` **allowedStoreProductsRelations**: `string`[] + +___ + +### allowedStoreVariantRelations + +• `Const` **allowedStoreVariantRelations**: `string`[] + +___ + +### defaulPaymentCollectionRelations + +• `Const` **defaulPaymentCollectionRelations**: `string`[] + +___ + +### defaultAdminBatchFields + +• `Const` **defaultAdminBatchFields**: `string`[] + +___ + +### defaultAdminCollectionsFields + +• `Const` **defaultAdminCollectionsFields**: `string`[] + +___ + +### defaultAdminCollectionsRelations + +• `Const` **defaultAdminCollectionsRelations**: `string`[] + +___ + +### defaultAdminCustomerGroupsRelations + +• `Const` **defaultAdminCustomerGroupsRelations**: `never`[] + +___ + +### defaultAdminCustomersRelations + +• `Const` **defaultAdminCustomersRelations**: `string`[] + +___ + +### defaultAdminDiscountConditionFields + +• `Const` **defaultAdminDiscountConditionFields**: keyof [`DiscountCondition`](../classes/admin_collections.internal.DiscountCondition.mdx)[] + +___ + +### defaultAdminDiscountConditionRelations + +• `Const` **defaultAdminDiscountConditionRelations**: `string`[] + +___ + +### defaultAdminDiscountsFields + +• `Const` **defaultAdminDiscountsFields**: keyof [`Discount`](../classes/admin_collections.internal.Discount.mdx)[] + +___ + +### defaultAdminDiscountsRelations + +• `Const` **defaultAdminDiscountsRelations**: `string`[] + +___ + +### defaultAdminDraftOrdersCartFields + +• `Const` **defaultAdminDraftOrdersCartFields**: keyof [`Cart`](../classes/admin_collections.internal.Cart.mdx)[] + +___ + +### defaultAdminDraftOrdersCartRelations + +• `Const` **defaultAdminDraftOrdersCartRelations**: `string`[] + +___ + +### defaultAdminDraftOrdersFields + +• `Const` **defaultAdminDraftOrdersFields**: keyof [`DraftOrder`](../classes/admin_collections.internal.DraftOrder.mdx)[] + +___ + +### defaultAdminDraftOrdersRelations + +• `Const` **defaultAdminDraftOrdersRelations**: `string`[] + +___ + +### defaultAdminGetProductsVariantsFields + +• `Const` **defaultAdminGetProductsVariantsFields**: `string`[] + +___ + +### defaultAdminGiftCardFields + +• `Const` **defaultAdminGiftCardFields**: keyof [`GiftCard`](../classes/admin_collections.internal.GiftCard.mdx)[] + +___ + +### defaultAdminGiftCardRelations + +• `Const` **defaultAdminGiftCardRelations**: `string`[] + +___ + +### defaultAdminInventoryItemFields + +• `Const` **defaultAdminInventoryItemFields**: keyof [`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[] + +___ + +### defaultAdminInventoryItemRelations + +• `Const` **defaultAdminInventoryItemRelations**: `never`[] + +___ + +### defaultAdminLocationLevelFields + +• `Const` **defaultAdminLocationLevelFields**: keyof [`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[] + +___ + +### defaultAdminNotificationsFields + +• `Const` **defaultAdminNotificationsFields**: `string`[] + +___ + +### defaultAdminNotificationsRelations + +• `Const` **defaultAdminNotificationsRelations**: `string`[] + +___ + +### defaultAdminPriceListFields + +• `Const` **defaultAdminPriceListFields**: `string`[] + +___ + +### defaultAdminPriceListRelations + +• `Const` **defaultAdminPriceListRelations**: `string`[] + +___ + +### defaultAdminProductCategoryRelations + +• `Const` **defaultAdminProductCategoryRelations**: `string`[] + +___ + +### defaultAdminProductFields + +• `Const` **defaultAdminProductFields**: keyof [`Product`](../classes/admin_collections.internal.Product.mdx)[] + +___ + +### defaultAdminProductRelations + +• `Const` **defaultAdminProductRelations**: `string`[] + +___ + +### defaultAdminProductRemoteQueryObject + +• `Const` **defaultAdminProductRemoteQueryObject**: `Object` + +This is temporary. + +#### Type declaration + + + +___ + +### defaultAdminProductTagsFields + +• `Const` **defaultAdminProductTagsFields**: `string`[] + +___ + +### defaultAdminProductTagsRelations + +• `Const` **defaultAdminProductTagsRelations**: `never`[] + +___ + +### defaultAdminProductTypeFields + +• `Const` **defaultAdminProductTypeFields**: `string`[] + +___ + +### defaultAdminProductTypeRelations + +• `Const` **defaultAdminProductTypeRelations**: `never`[] + +___ + +### defaultAdminRegionFields + +• `Const` **defaultAdminRegionFields**: keyof [`Region`](../classes/admin_collections.internal.Region.mdx)[] + +___ + +### defaultAdminRegionRelations + +• `Const` **defaultAdminRegionRelations**: `string`[] + +___ + +### defaultAdminReservationRelations + +• `Const` **defaultAdminReservationRelations**: `never`[] + +___ + +### defaultAdminReturnReasonsFields + +• `Const` **defaultAdminReturnReasonsFields**: keyof [`ReturnReason`](../classes/admin_collections.internal.ReturnReason.mdx)[] + +___ + +### defaultAdminReturnReasonsRelations + +• `Const` **defaultAdminReturnReasonsRelations**: keyof [`ReturnReason`](../classes/admin_collections.internal.ReturnReason.mdx)[] + +___ + +### defaultAdminShippingProfilesFields + +• `Const` **defaultAdminShippingProfilesFields**: keyof [`ShippingProfile`](../classes/admin_collections.internal.ShippingProfile.mdx)[] + +___ + +### defaultAdminShippingProfilesRelations + +• `Const` **defaultAdminShippingProfilesRelations**: `string`[] + +___ + +### defaultAdminStockLocationFields + +• `Const` **defaultAdminStockLocationFields**: keyof [`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[] + +___ + +### defaultAdminStockLocationRelations + +• `Const` **defaultAdminStockLocationRelations**: `never`[] + +___ + +### defaultAdminSwapFields + +• `Const` **defaultAdminSwapFields**: `string`[] + +___ + +### defaultAdminSwapRelations + +• `Const` **defaultAdminSwapRelations**: `string`[] + +___ + +### defaultAdminTaxRatesFields + +• `Const` **defaultAdminTaxRatesFields**: keyof [`TaxRate`](../classes/admin_collections.internal.TaxRate.mdx)[] + +___ + +### defaultAdminTaxRatesRelations + +• `Const` **defaultAdminTaxRatesRelations**: `never`[] + +___ + +### defaultAdminVariantFields + +• `Const` **defaultAdminVariantFields**: keyof [`ProductVariant`](../classes/admin_collections.internal.ProductVariant.mdx)[] + +___ + +### defaultAdminVariantRelations + +• `Const` **defaultAdminVariantRelations**: `string`[] + +___ + +### defaultFields + +• `Const` **defaultFields**: keyof [`ShippingOption`](../classes/admin_collections.internal.ShippingOption.mdx)[] + +___ + +### defaultPaymentCollectionFields + +• `Const` **defaultPaymentCollectionFields**: `string`[] + +___ + +### defaultPaymentCollectionRelations + +• `Const` **defaultPaymentCollectionRelations**: `string`[] + +___ + +### defaultPaymentFields + +• `Const` **defaultPaymentFields**: `string`[] + +___ + +### defaultProductCategoryFields + +• `Const` **defaultProductCategoryFields**: `string`[] + +___ + +### defaultRelations + +• `Const` **defaultRelations**: `string`[] + +___ + +### defaultRelationsExtended + +• `Const` **defaultRelationsExtended**: `string`[] + +___ + +### defaultRelationsList + +• `Const` **defaultRelationsList**: `string`[] + +___ + +### defaultReservationFields + +• `Const` **defaultReservationFields**: `string`[] + +___ + +### defaultReturnCancelFields + +• `Const` **defaultReturnCancelFields**: keyof [`Order`](../classes/admin_collections.internal.Order.mdx)[] + +___ + +### defaultReturnCancelRelations + +• `Const` **defaultReturnCancelRelations**: `string`[] + +___ + +### defaultStoreCartFields + +• `Const` **defaultStoreCartFields**: keyof [`Cart`](../classes/admin_collections.internal.Cart.mdx)[] + +___ + +### defaultStoreCartRelations + +• `Const` **defaultStoreCartRelations**: `string`[] + +___ + +### defaultStoreCategoryScope + +• `Const` **defaultStoreCategoryScope**: `Object` + +#### Type declaration + + + +___ + +### defaultStoreCollectionRelations + +• `Const` **defaultStoreCollectionRelations**: `never`[] + +___ + +### defaultStoreCustomersFields + +• `Const` **defaultStoreCustomersFields**: keyof [`Customer`](../classes/admin_collections.internal.Customer.mdx)[] + +___ + +### defaultStoreCustomersRelations + +• `Const` **defaultStoreCustomersRelations**: `string`[] + +___ + +### defaultStoreGiftCardFields + +• `Const` **defaultStoreGiftCardFields**: keyof [`GiftCard`](../classes/admin_collections.internal.GiftCard.mdx)[] + +___ + +### defaultStoreGiftCardRelations + +• `Const` **defaultStoreGiftCardRelations**: `string`[] + +___ + +### defaultStoreOrdersFields + +• `Const` **defaultStoreOrdersFields**: keyof [`Order`](../classes/admin_collections.internal.Order.mdx)[] + +___ + +### defaultStoreOrdersRelations + +• `Const` **defaultStoreOrdersRelations**: `string`[] + +___ + +### defaultStoreProductCategoryFields + +• `Const` **defaultStoreProductCategoryFields**: `string`[] + +___ + +### defaultStoreProductCategoryRelations + +• `Const` **defaultStoreProductCategoryRelations**: `string`[] + +___ + +### defaultStoreProductRemoteQueryObject + +• `Const` **defaultStoreProductRemoteQueryObject**: `Object` + +This is temporary. + +#### Type declaration + + + +___ + +### defaultStoreProductTagFields + +• `Const` **defaultStoreProductTagFields**: `string`[] + +___ + +### defaultStoreProductTagRelations + +• `Const` **defaultStoreProductTagRelations**: `never`[] + +___ + +### defaultStoreProductTypeFields + +• `Const` **defaultStoreProductTypeFields**: `string`[] + +___ + +### defaultStoreProductTypeRelations + +• `Const` **defaultStoreProductTypeRelations**: `never`[] + +___ + +### defaultStoreProductsFields + +• `Const` **defaultStoreProductsFields**: keyof [`Product`](../classes/admin_collections.internal.Product.mdx)[] + +___ + +### defaultStoreProductsRelations + +• `Const` **defaultStoreProductsRelations**: `string`[] + +___ + +### defaultStoreReturnReasonFields + +• `Const` **defaultStoreReturnReasonFields**: keyof [`ReturnReason`](../classes/admin_collections.internal.ReturnReason.mdx)[] + +___ + +### defaultStoreReturnReasonRelations + +• `Const` **defaultStoreReturnReasonRelations**: keyof [`ReturnReason`](../classes/admin_collections.internal.ReturnReason.mdx)[] + +___ + +### defaultStoreSwapFields + +• `Const` **defaultStoreSwapFields**: [`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Swap`](../classes/admin_collections.internal.Swap.mdx)\>[``"select"``] + +___ + +### defaultStoreSwapRelations + +• `Const` **defaultStoreSwapRelations**: `string`[] + +___ + +### defaultStoreVariantRelations + +• `Const` **defaultStoreVariantRelations**: `string`[] + +___ + +### filterableAdminOrdersFields + +• `Const` **filterableAdminOrdersFields**: `string`[] + +## Functions + +### DbAwareColumn + +▸ **DbAwareColumn**(`columnOptions`): [`PropertyDecorator`](../../admin_discounts/modules/admin_discounts.internal.mdx#propertydecorator) + +#### Parameters + + + +#### Returns + +[`PropertyDecorator`](../../admin_discounts/modules/admin_discounts.internal.mdx#propertydecorator) + + `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +___ + +### IsType + +▸ **IsType**(`types`, `validationOptions?`): (`object`: [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object), `propertyName`: `string`) => `void` + +#### Parameters + + + +#### Returns + +`fn` + + `void`", + "type": "(`object`: [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object), `propertyName`: `string`) => `void`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ (`object`, `propertyName`): `void` + +##### Parameters + + + +##### Returns + +`void` + + + +___ + +### addOrderToSelect + +▸ **addOrderToSelect**<`TEntity`\>(`order`, `select`): `void` + + + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "`FindOptionsSelect`<`TEntity`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### adjustInventoryForCancelledFulfillment + +▸ **adjustInventoryForCancelledFulfillment**(`fulfillment`, `context`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### authenticate + +▸ **authenticate**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> + +#### Returns + +`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "Record", + "type": "Record<`string`, `any`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### authenticateCustomer + +▸ **authenticateCustomer**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> + +#### Returns + +`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "Record", + "type": "Record<`string`, `any`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### buildLegacyFieldsListFrom + +▸ **buildLegacyFieldsListFrom**<`TEntity`\>(`input?`): keyof `TEntity`[] + +Revert new object structure of find options to the legacy structure of previous version + + + +#### Example + +```ts +input: { + test: { + test1: true, + test2: true, + test3: { + test4: true + }, + }, + test2: true +} +output: ['test.test1', 'test.test2', 'test.test3.test4', 'test2'] +``` + +#### Parameters + + \\| `FindOptionsSelect`<`TEntity`\\> \\| `FindOptionsOrder`<`TEntity`\\> \\| `FindOptionsRelations`<`TEntity`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +keyof `TEntity`[] + + + +#### Deprecated + +in favor of import { objectToStringPath } from "@medusajs/utils" + +___ + +### buildQuery + +▸ **buildQuery**<`TWhereKeys`, `TEntity`\>(`selector`, `config?`): [`ExtendedFindConfig`](admin_discounts.internal.internal.mdx#extendedfindconfig)<`TEntity`\> + +Used to build TypeORM queries. + + + +#### Parameters + +", + "description": "The config", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +[`ExtendedFindConfig`](admin_discounts.internal.internal.mdx#extendedfindconfig)<`TEntity`\> + +", + "optional": false, + "defaultValue": "", + "description": "The QueryBuilderConfig", + "children": [] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`number` + + + +___ + +### canAccessBatchJob + +▸ **canAccessBatchJob**(`req`, `res`, `next`): `Promise`<`any`\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### categoryMatchesScope + +▸ **categoryMatchesScope**(`category`, `query`): `boolean` + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`boolean` + + + +___ + +### cleanResponseData + +▸ **cleanResponseData**<`T`\>(`data`, `fields`): `T` extends [] ? [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<`T`\>[] : [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<`T`\> + +Filter response data to contain props specified in the `allowedProperties`. +You can read more in the transformQuery middleware utility methods. + + + +#### Parameters + + + +#### Returns + +`T` extends [] ? [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<`T`\>[] : [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<`T`\> + +[] : [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<`T`\\>", + "type": "`T` extends [] ? [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<`T`\\>[] : [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<`T`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### csvCellContentFormatter + +▸ **csvCellContentFormatter**(`str`): `string` + +#### Parameters + + + +#### Returns + +`string` + + + +___ + +### csvRevertCellContentFormatter + +▸ **csvRevertCellContentFormatter**(`str`): `string` + +#### Parameters + + + +#### Returns + +`string` + + + +___ + +### doesConditionBelongToDiscount + +▸ **doesConditionBelongToDiscount**(`req`, `res`, `next`): `Promise`<`any`\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### errorHandler + +▸ **errorHandler**(): (`err`: [`MedusaError`](../classes/admin_discounts.internal.MedusaError.mdx), `req`: `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\>, `res`: `Response`<`any`, Record<`string`, `any`\>\>, `next`: `NextFunction`) => `void` + +#### Returns + +`fn` + +\\>, `res`: `Response`<`any`, Record<`string`, `any`\\>\\>, `next`: `NextFunction`) => `void`", + "type": "(`err`: [`MedusaError`](../classes/admin_discounts.internal.MedusaError.mdx), `req`: `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\\>\\>, `res`: `Response`<`any`, Record<`string`, `any`\\>\\>, `next`: `NextFunction`) => `void`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ (`err`, `req`, `res`, `next`): `void` + +##### Parameters + +\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "res", + "type": "`Response`<`any`, Record<`string`, `any`\\>\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "next", + "type": "`NextFunction`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +`void` + + + +___ + +### extendedFindParamsMixin + +▸ **extendedFindParamsMixin**(`«destructured»?`): [`ClassConstructor`](admin_discounts.internal.internal.mdx#classconstructor)<[`FindParams`](../classes/admin_customer_groups.internal.FindParams.mdx) & [`FindPaginationParams`](../classes/admin_currencies.internal.FindPaginationParams.mdx)\> + +#### Parameters + + + +#### Returns + +[`ClassConstructor`](admin_discounts.internal.internal.mdx#classconstructor)<[`FindParams`](../classes/admin_customer_groups.internal.FindParams.mdx) & [`FindPaginationParams`](../classes/admin_currencies.internal.FindPaginationParams.mdx)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "[`FindParams`](../classes/admin_customer_groups.internal.FindParams.mdx) & [`FindPaginationParams`](../classes/admin_currencies.internal.FindPaginationParams.mdx)", + "type": "[`FindParams`](../classes/admin_customer_groups.internal.FindParams.mdx) & [`FindPaginationParams`](../classes/admin_currencies.internal.FindPaginationParams.mdx)", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### fetchCategoryDescendantsIds + +▸ **fetchCategoryDescendantsIds**(`productCategory`, `query`): `string`[] + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`string`[] + + + +___ + +### formatException + +▸ **formatException**(`err`): [`MedusaError`](../classes/admin_discounts.internal.MedusaError.mdx) + +#### Parameters + + + +#### Returns + +[`MedusaError`](../classes/admin_discounts.internal.MedusaError.mdx) + + + +___ + +### 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 + + + +#### Returns + +`string` + + + +___ + +### getRequestedBatchJob + +▸ **getRequestedBatchJob**(`req`, `res`, `next`): `Promise`<`any`\> + +#### Parameters + + + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### hasChanges + +▸ **hasChanges**<`T1`, `T2`\>(`obj1`, `obj2`): `boolean` + +Compare two objects and return true if there is changes detected from obj2 compared to obj1 + + + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### isBatchJobStrategy + +▸ **isBatchJobStrategy**(`object`): object is IBatchJobStrategy + +#### Parameters + + + +#### Returns + +object is IBatchJobStrategy + + + +___ + +### isCartCompletionStrategy + +▸ **isCartCompletionStrategy**(`obj`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### isDate + +▸ **isDate**(`value`): value is Date + +#### Parameters + + + +#### Returns + +value is Date + + + +___ + +### isFileService + +▸ **isFileService**(`object`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### isNotificationService + +▸ **isNotificationService**(`obj`): `boolean` + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### isObject + +▸ **isObject**(`obj`): obj is object + +#### Parameters + + + +#### Returns + +obj is object + + + +___ + +### isPaymentProcessor + +▸ **isPaymentProcessor**(`obj`): `boolean` + +Return if the input object is AbstractPaymentProcessor + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### isPaymentProcessorError + +▸ **isPaymentProcessorError**(`obj`): obj is PaymentProcessorError + +Utility function to determine if an object is a processor error + +#### Parameters + + + +#### Returns + +obj is PaymentProcessorError + + + +___ + +### isPaymentService + +▸ **isPaymentService**(`obj`): `boolean` + +Return if the input object is one of AbstractPaymentService or PaymentService or AbstractPaymentPluginService + +#### Parameters + + + +#### Returns + +`boolean` + + + +___ + +### isPriceSelectionStrategy + +▸ **isPriceSelectionStrategy**(`object`): object is IPriceSelectionStrategy + +#### Parameters + + + +#### Returns + +object is IPriceSelectionStrategy + + + +___ + +### isString + +▸ **isString**(`val`): val is string + +#### Parameters + + + +#### Returns + +val is string + + + +___ + +### isTaxCalculationStrategy + +▸ **isTaxCalculationStrategy**(`object`): object is ITaxCalculationStrategy + +#### Parameters + + + +#### Returns + +object is ITaxCalculationStrategy + + + +___ + +### normalizeQuery + +▸ **normalizeQuery**(): (`req`: `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\>, `res`: `Response`<`any`, 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` + +\\>, `res`: `Response`<`any`, Record<`string`, `any`\\>\\>, `next`: `NextFunction`) => `void`", + "type": "(`req`: `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\\>\\>, `res`: `Response`<`any`, Record<`string`, `any`\\>\\>, `next`: `NextFunction`) => `void`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ (`req`, `res`, `next`): `void` + +##### Parameters + +\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "res", + "type": "`Response`<`any`, Record<`string`, `any`\\>\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "next", + "type": "`NextFunction`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +##### Returns + +`void` + + + +___ + +### nullableValue + +▸ **nullableValue**(`value`): `FindOperator`<`any`\> + +#### Parameters + + + +#### Returns + +`FindOperator`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### omitDeep + +▸ **omitDeep**<`T`\>(`input`, `excludes`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +___ + +### 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 + +#### 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) +``` + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`void` + + + +___ + +### remoteQueryFetchData + +▸ **remoteQueryFetchData**(`container`): (`expand`: `any`, `keyField`: `any`, `ids`: `any`, `relationship`: `any`) => `Promise`<`any`\> + +#### Parameters + + + +#### Returns + +`fn` + + `Promise`<`any`\\>", + "type": "(`expand`: `any`, `keyField`: `any`, `ids`: `any`, `relationship`: `any`) => `Promise`<`any`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ (`expand`, `keyField`, `ids`, `relationship`): `Promise`<`any`\> + +##### Parameters + + + +##### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### removeUndefinedProperties + +▸ **removeUndefinedProperties**<`T`\>(`inputObj`): `T` + + + +#### Parameters + + + +#### Returns + +`T` + + + +___ + +### requireCustomerAuthentication + +▸ **requireCustomerAuthentication**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> + +#### Returns + +`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "Record", + "type": "Record<`string`, `any`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> + +___ + +### reserveQuantityForDraftOrder + +▸ **reserveQuantityForDraftOrder**(`order`, `context`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### resolveDbGenerationStrategy + +▸ **resolveDbGenerationStrategy**(`pgSqlType`): ``"increment"`` \| ``"uuid"`` \| ``"rowid"`` + +#### Parameters + + + +#### Returns + +``"increment"`` \| ``"uuid"`` \| ``"rowid"`` + + + +___ + +### resolveDbType + +▸ **resolveDbType**(`pgSqlType`): `ColumnType` + +#### Parameters + + + +#### Returns + +`ColumnType` + + + +___ + +### setMetadata + +▸ **setMetadata**(`obj`, `metadata`): Record<`string`, `unknown`\> + +Dedicated method to set metadata. + +#### Parameters + + }", + "description": "the entity to apply metadata to.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "the metadata to set", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +Record<`string`, `unknown`\> + +", + "optional": false, + "defaultValue": "", + "description": "resolves to the updated result.", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "unknown", + "type": "`unknown`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### transformBody + +▸ **transformBody**<`T`\>(`plainToClass`, `config?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\> + + + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "`ValidatorOptions`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`fn` + + `Promise`<`void`\\>", + "type": "(`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ (`req`, `res`, `next`): `Promise`<`void`\> + +##### Parameters + + + +##### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### 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 + + + +#### Returns + +`fn` + + `void`", + "type": "(`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `void`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ (`req`, `res`, `next`): `void` + +##### Parameters + + + +##### Returns + +`void` + + + +___ + +### 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 + + + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "queryConfig", + "type": "[`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`QueryConfig`](admin_discounts.internal.internal.mdx#queryconfig)<`TEntity`\\>, ``\"allowedRelations\"`` \\| ``\"allowedFields\"``\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "`ValidatorOptions`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`fn` + + `Promise`<`void`\\>", + "type": "(`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ (`req`, `res`, `next`): `Promise`<`void`\> + +##### Parameters + + + +##### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### 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 + + + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "queryConfig", + "type": "[`QueryConfig`](admin_discounts.internal.internal.mdx#queryconfig)<`TEntity`\\>", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "`ValidatorOptions`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`fn` + + `Promise`<`void`\\>", + "type": "(`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\\>", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +▸ (`req`, `res`, `next`): `Promise`<`void`\> + +##### Parameters + + + +##### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### unauthenticatedInviteRoutes + +▸ **unauthenticatedInviteRoutes**(`app`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### unauthenticatedUserRoutes + +▸ **unauthenticatedUserRoutes**(`app`): `void` + +#### Parameters + + + +#### Returns + +`void` + + + +___ + +### updateInventoryAndReservations + +▸ **updateInventoryAndReservations**(`fulfillments`, `context`): `Promise`<`void`\> + +#### Parameters + + + +#### Returns + +`Promise`<`void`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### validateId + +▸ **validateId**(`rawId`, `config?`): `string` + +#### Parameters + + + +#### Returns + +`string` + + + +___ + +### validator + +▸ **validator**<`T`, `V`\>(`typedClass`, `plain`, `config?`): `Promise`<`T`\> + + + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "plain", + "type": "`V`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "config", + "type": "`ValidatorOptions`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`T`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + } +]} /> + +___ + +### wrapHandler + +▸ **wrapHandler**(`fn`): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> + +#### Parameters + + + +#### Returns + +`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> + +\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "Record", + "type": "Record<`string`, `any`\\>", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "string", + "type": "`string`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/line_items/classes/line_items.LineItemsResource.mdx b/www/apps/docs/content/references/js-client/line_items/classes/line_items.LineItemsResource.mdx new file mode 100644 index 0000000000..8e671e0c04 --- /dev/null +++ b/www/apps/docs/content/references/js-client/line_items/classes/line_items.LineItemsResource.mdx @@ -0,0 +1,201 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# LineItemsResource + +[line-items](../../modules/line_items.mdx).LineItemsResource + +## Methods + +### create + +▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +Creates a line-item for a cart + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCartsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### delete + +▸ **delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +Remove a line-item from a cart + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCartsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### update + +▸ **update**(`cart_id`, `line_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +Updates a line-item. +Only quantity updates are allowed + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCartsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/modules/addresses.mdx b/www/apps/docs/content/references/js-client/modules/addresses.mdx new file mode 100644 index 0000000000..02c074abc1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/addresses.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# addresses + +## Modules + +- [internal](../addresses/modules/addresses.internal.mdx) + +## Classes + +- [AddressesResource](../addresses/classes/addresses.AddressesResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin.mdx b/www/apps/docs/content/references/js-client/modules/admin.mdx new file mode 100644 index 0000000000..ffbcfb7771 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin.mdx @@ -0,0 +1,227 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin + +## Classes + +- [Admin](../admin/classes/admin.Admin.mdx) + +## References + +### AdminAuthResource + +Re-exports [AdminAuthResource](../admin_auth/classes/admin_auth.AdminAuthResource.mdx) + +___ + +### AdminBatchJobsResource + +Re-exports [AdminBatchJobsResource](../admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx) + +___ + +### AdminCollectionsResource + +Re-exports [AdminCollectionsResource](../admin_collections/classes/admin_collections.AdminCollectionsResource.mdx) + +___ + +### AdminCurrenciesResource + +Re-exports [AdminCurrenciesResource](../admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx) + +___ + +### AdminCustomResource + +Re-exports [AdminCustomResource](../admin_custom/classes/admin_custom.AdminCustomResource.mdx) + +___ + +### AdminCustomerGroupsResource + +Re-exports [AdminCustomerGroupsResource](../admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx) + +___ + +### AdminCustomersResource + +Re-exports [AdminCustomersResource](../admin_customers/classes/admin_customers.AdminCustomersResource.mdx) + +___ + +### AdminDiscountsResource + +Re-exports [AdminDiscountsResource](../admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx) + +___ + +### AdminDraftOrdersResource + +Re-exports [AdminDraftOrdersResource](../admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx) + +___ + +### AdminGiftCardsResource + +Re-exports [AdminGiftCardsResource](../admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx) + +___ + +### AdminInvitesResource + +Re-exports [AdminInvitesResource](../admin_invites/classes/admin_invites.AdminInvitesResource.mdx) + +___ + +### AdminNotesResource + +Re-exports [AdminNotesResource](../admin_notes/classes/admin_notes.AdminNotesResource.mdx) + +___ + +### AdminNotificationsResource + +Re-exports [AdminNotificationsResource](../admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx) + +___ + +### AdminOrderEditsResource + +Re-exports [AdminOrderEditsResource](../admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx) + +___ + +### AdminOrdersResource + +Re-exports [AdminOrdersResource](../admin_orders/classes/admin_orders.AdminOrdersResource.mdx) + +___ + +### AdminPaymentCollectionsResource + +Re-exports [AdminPaymentCollectionsResource](../admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx) + +___ + +### AdminPaymentsResource + +Re-exports [AdminPaymentsResource](../admin_payments/classes/admin_payments.AdminPaymentsResource.mdx) + +___ + +### AdminPriceListResource + +Re-exports [AdminPriceListResource](../admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx) + +___ + +### AdminProductCategoriesResource + +Re-exports [AdminProductCategoriesResource](../admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx) + +___ + +### AdminProductTagsResource + +Re-exports [AdminProductTagsResource](../admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx) + +___ + +### AdminProductTypesResource + +Re-exports [AdminProductTypesResource](../admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx) + +___ + +### AdminProductsResource + +Re-exports [AdminProductsResource](../admin_products/classes/admin_products.AdminProductsResource.mdx) + +___ + +### AdminPublishableApiKeyResource + +Re-exports [AdminPublishableApiKeyResource](../admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx) + +___ + +### AdminRegionsResource + +Re-exports [AdminRegionsResource](../admin_regions/classes/admin_regions.AdminRegionsResource.mdx) + +___ + +### AdminReturnReasonsResource + +Re-exports [AdminReturnReasonsResource](../admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx) + +___ + +### AdminReturnsResource + +Re-exports [AdminReturnsResource](../admin_returns/classes/admin_returns.AdminReturnsResource.mdx) + +___ + +### AdminSalesChannelsResource + +Re-exports [AdminSalesChannelsResource](../admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx) + +___ + +### AdminShippingOptionsResource + +Re-exports [AdminShippingOptionsResource](../admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx) + +___ + +### AdminShippingProfilesResource + +Re-exports [AdminShippingProfilesResource](../admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx) + +___ + +### AdminStockLocationsResource + +Re-exports [AdminStockLocationsResource](../admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx) + +___ + +### AdminStoresResource + +Re-exports [AdminStoresResource](../admin_store/classes/admin_store.AdminStoresResource.mdx) + +___ + +### AdminSwapsResource + +Re-exports [AdminSwapsResource](../admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx) + +___ + +### AdminTaxRatesResource + +Re-exports [AdminTaxRatesResource](../admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx) + +___ + +### AdminUploadsResource + +Re-exports [AdminUploadsResource](../admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx) + +___ + +### AdminUsersResource + +Re-exports [AdminUsersResource](../admin_users/classes/admin_users.AdminUsersResource.mdx) + +___ + +### AdminVariantsResource + +Re-exports [AdminVariantsResource](../admin_variants/classes/admin_variants.AdminVariantsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_auth.mdx b/www/apps/docs/content/references/js-client/modules/admin_auth.mdx new file mode 100644 index 0000000000..6743d4924e --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_auth.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/auth + +## Modules + +- [internal](../admin_auth/modules/admin_auth.internal.mdx) + +## Classes + +- [AdminAuthResource](../admin_auth/classes/admin_auth.AdminAuthResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_batch_jobs.mdx b/www/apps/docs/content/references/js-client/modules/admin_batch_jobs.mdx new file mode 100644 index 0000000000..59a776989b --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_batch_jobs.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/batch-jobs + +## Modules + +- [internal](../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx) + +## Classes + +- [AdminBatchJobsResource](../admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_collections.mdx b/www/apps/docs/content/references/js-client/modules/admin_collections.mdx new file mode 100644 index 0000000000..73b22a6c0f --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_collections.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/collections + +## Modules + +- [internal](../admin_collections/modules/admin_collections.internal.mdx) + +## Classes + +- [AdminCollectionsResource](../admin_collections/classes/admin_collections.AdminCollectionsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_currencies.mdx b/www/apps/docs/content/references/js-client/modules/admin_currencies.mdx new file mode 100644 index 0000000000..5e4dca0424 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_currencies.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/currencies + +## Modules + +- [internal](../admin_currencies/modules/admin_currencies.internal.mdx) + +## Classes + +- [AdminCurrenciesResource](../admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_custom.mdx b/www/apps/docs/content/references/js-client/modules/admin_custom.mdx new file mode 100644 index 0000000000..c1f120ffa0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_custom.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/custom + +## Modules + +- [internal](../admin_custom/modules/admin_custom.internal.mdx) + +## Classes + +- [AdminCustomResource](../admin_custom/classes/admin_custom.AdminCustomResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_customer_groups.mdx b/www/apps/docs/content/references/js-client/modules/admin_customer_groups.mdx new file mode 100644 index 0000000000..4222c12b3a --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_customer_groups.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/customer-groups + +## Modules + +- [internal](../admin_customer_groups/modules/admin_customer_groups.internal.mdx) + +## Classes + +- [AdminCustomerGroupsResource](../admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_customers.mdx b/www/apps/docs/content/references/js-client/modules/admin_customers.mdx new file mode 100644 index 0000000000..0dc6cf0490 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_customers.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/customers + +## Modules + +- [internal](../admin_customers/modules/admin_customers.internal.mdx) + +## Classes + +- [AdminCustomersResource](../admin_customers/classes/admin_customers.AdminCustomersResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_discounts.mdx b/www/apps/docs/content/references/js-client/modules/admin_discounts.mdx new file mode 100644 index 0000000000..c979f4a23f --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_discounts.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/discounts + +## Modules + +- [internal](../admin_discounts/modules/admin_discounts.internal.mdx) + +## Classes + +- [AdminDiscountsResource](../admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_draft_orders.mdx b/www/apps/docs/content/references/js-client/modules/admin_draft_orders.mdx new file mode 100644 index 0000000000..4863e26ac2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_draft_orders.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/draft-orders + +## Classes + +- [AdminDraftOrdersResource](../admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_gift_cards.mdx b/www/apps/docs/content/references/js-client/modules/admin_gift_cards.mdx new file mode 100644 index 0000000000..ed4e68aa3d --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_gift_cards.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/gift-cards + +## Classes + +- [AdminGiftCardsResource](../admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_inventory_item.mdx b/www/apps/docs/content/references/js-client/modules/admin_inventory_item.mdx new file mode 100644 index 0000000000..4c629bd3be --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_inventory_item.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/inventory-item + +## Classes + +- [AdminInventoryItemsResource](../admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_invites.mdx b/www/apps/docs/content/references/js-client/modules/admin_invites.mdx new file mode 100644 index 0000000000..cdb56c76aa --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_invites.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/invites + +## Modules + +- [internal](../admin_invites/modules/admin_invites.internal.mdx) + +## Classes + +- [AdminInvitesResource](../admin_invites/classes/admin_invites.AdminInvitesResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_notes.mdx b/www/apps/docs/content/references/js-client/modules/admin_notes.mdx new file mode 100644 index 0000000000..9f3831227d --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_notes.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/notes + +## Classes + +- [AdminNotesResource](../admin_notes/classes/admin_notes.AdminNotesResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_notifications.mdx b/www/apps/docs/content/references/js-client/modules/admin_notifications.mdx new file mode 100644 index 0000000000..a674366dd5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_notifications.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/notifications + +## Classes + +- [AdminNotificationsResource](../admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_order_edits.mdx b/www/apps/docs/content/references/js-client/modules/admin_order_edits.mdx new file mode 100644 index 0000000000..0ab38c630d --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_order_edits.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/order-edits + +## Classes + +- [AdminOrderEditsResource](../admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_orders.mdx b/www/apps/docs/content/references/js-client/modules/admin_orders.mdx new file mode 100644 index 0000000000..c0ddcbfcbd --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_orders.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/orders + +## Classes + +- [AdminOrdersResource](../admin_orders/classes/admin_orders.AdminOrdersResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_payment_collections.mdx b/www/apps/docs/content/references/js-client/modules/admin_payment_collections.mdx new file mode 100644 index 0000000000..1d11eaafc9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_payment_collections.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/payment-collections + +## Classes + +- [AdminPaymentCollectionsResource](../admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_payments.mdx b/www/apps/docs/content/references/js-client/modules/admin_payments.mdx new file mode 100644 index 0000000000..60a6824c1c --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_payments.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/payments + +## Classes + +- [AdminPaymentsResource](../admin_payments/classes/admin_payments.AdminPaymentsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_price_lists.mdx b/www/apps/docs/content/references/js-client/modules/admin_price_lists.mdx new file mode 100644 index 0000000000..e730ce066a --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_price_lists.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/price-lists + +## Classes + +- [AdminPriceListResource](../admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_product_categories.mdx b/www/apps/docs/content/references/js-client/modules/admin_product_categories.mdx new file mode 100644 index 0000000000..c9fca855db --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_product_categories.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/product-categories + +## Classes + +- [AdminProductCategoriesResource](../admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_product_tags.mdx b/www/apps/docs/content/references/js-client/modules/admin_product_tags.mdx new file mode 100644 index 0000000000..0d350a2daf --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_product_tags.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/product-tags + +## Classes + +- [AdminProductTagsResource](../admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_product_types.mdx b/www/apps/docs/content/references/js-client/modules/admin_product_types.mdx new file mode 100644 index 0000000000..b787f8b0b6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_product_types.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/product-types + +## Classes + +- [AdminProductTypesResource](../admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_products.mdx b/www/apps/docs/content/references/js-client/modules/admin_products.mdx new file mode 100644 index 0000000000..acb2f697e3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_products.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/products + +## Classes + +- [AdminProductsResource](../admin_products/classes/admin_products.AdminProductsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_publishable_api_keys.mdx b/www/apps/docs/content/references/js-client/modules/admin_publishable_api_keys.mdx new file mode 100644 index 0000000000..48f249be31 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_publishable_api_keys.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/publishable-api-keys + +## Classes + +- [AdminPublishableApiKeyResource](../admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_regions.mdx b/www/apps/docs/content/references/js-client/modules/admin_regions.mdx new file mode 100644 index 0000000000..25c822769f --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_regions.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/regions + +## Classes + +- [AdminRegionsResource](../admin_regions/classes/admin_regions.AdminRegionsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_reservations.mdx b/www/apps/docs/content/references/js-client/modules/admin_reservations.mdx new file mode 100644 index 0000000000..299f1f7210 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_reservations.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/reservations + +## Classes + +- [AdminReservationsResource](../admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_return_reasons.mdx b/www/apps/docs/content/references/js-client/modules/admin_return_reasons.mdx new file mode 100644 index 0000000000..87582996bf --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_return_reasons.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/return-reasons + +## Classes + +- [AdminReturnReasonsResource](../admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_returns.mdx b/www/apps/docs/content/references/js-client/modules/admin_returns.mdx new file mode 100644 index 0000000000..4ac2456702 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_returns.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/returns + +## Classes + +- [AdminReturnsResource](../admin_returns/classes/admin_returns.AdminReturnsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_sales_channels.mdx b/www/apps/docs/content/references/js-client/modules/admin_sales_channels.mdx new file mode 100644 index 0000000000..a7e6a5b52f --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_sales_channels.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/sales-channels + +## Classes + +- [AdminSalesChannelsResource](../admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_shipping_options.mdx b/www/apps/docs/content/references/js-client/modules/admin_shipping_options.mdx new file mode 100644 index 0000000000..b05eee1c01 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_shipping_options.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/shipping-options + +## Classes + +- [AdminShippingOptionsResource](../admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_shipping_profiles.mdx b/www/apps/docs/content/references/js-client/modules/admin_shipping_profiles.mdx new file mode 100644 index 0000000000..a7ebcfd0c6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_shipping_profiles.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/shipping-profiles + +## Classes + +- [AdminShippingProfilesResource](../admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_stock_locations.mdx b/www/apps/docs/content/references/js-client/modules/admin_stock_locations.mdx new file mode 100644 index 0000000000..c3ac8b3588 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_stock_locations.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/stock-locations + +## Classes + +- [AdminStockLocationsResource](../admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_store.mdx b/www/apps/docs/content/references/js-client/modules/admin_store.mdx new file mode 100644 index 0000000000..4618cbb868 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_store.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/store + +## Classes + +- [AdminStoresResource](../admin_store/classes/admin_store.AdminStoresResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_swaps.mdx b/www/apps/docs/content/references/js-client/modules/admin_swaps.mdx new file mode 100644 index 0000000000..83cf302e8a --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_swaps.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/swaps + +## Classes + +- [AdminSwapsResource](../admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_tax_rates.mdx b/www/apps/docs/content/references/js-client/modules/admin_tax_rates.mdx new file mode 100644 index 0000000000..b2cc44eb91 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_tax_rates.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/tax-rates + +## Classes + +- [AdminTaxRatesResource](../admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_uploads.mdx b/www/apps/docs/content/references/js-client/modules/admin_uploads.mdx new file mode 100644 index 0000000000..426b1cdcfc --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_uploads.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/uploads + +## Modules + +- [internal](../admin_uploads/modules/admin_uploads.internal.mdx) + +## Classes + +- [AdminUploadsResource](../admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_users.mdx b/www/apps/docs/content/references/js-client/modules/admin_users.mdx new file mode 100644 index 0000000000..6c5469887e --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_users.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/users + +## Modules + +- [internal](../admin_users/modules/admin_users.internal.mdx) + +## Classes + +- [AdminUsersResource](../admin_users/classes/admin_users.AdminUsersResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/admin_variants.mdx b/www/apps/docs/content/references/js-client/modules/admin_variants.mdx new file mode 100644 index 0000000000..f6f872b49e --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/admin_variants.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# admin/variants + +## Classes + +- [AdminVariantsResource](../admin_variants/classes/admin_variants.AdminVariantsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/auth.mdx b/www/apps/docs/content/references/js-client/modules/auth.mdx new file mode 100644 index 0000000000..875807db3e --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/auth.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# auth + +## Classes + +- [AuthResource](../auth/classes/auth.AuthResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/carts.mdx b/www/apps/docs/content/references/js-client/modules/carts.mdx new file mode 100644 index 0000000000..0fdec5edc8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/carts.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# carts + +## Classes + +- [CartsResource](../carts/classes/carts.CartsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/collections.mdx b/www/apps/docs/content/references/js-client/modules/collections.mdx new file mode 100644 index 0000000000..3c2093b6a9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/collections.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# collections + +## Classes + +- [CollectionsResource](../collections/classes/collections.CollectionsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/customers.mdx b/www/apps/docs/content/references/js-client/modules/customers.mdx new file mode 100644 index 0000000000..d994c66b03 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/customers.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# customers + +## Classes + +- [CustomerResource](../customers/classes/customers.CustomerResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/gift_cards.mdx b/www/apps/docs/content/references/js-client/modules/gift_cards.mdx new file mode 100644 index 0000000000..c961c4a4bc --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/gift_cards.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# gift-cards + +## Classes + +- [GiftCardsResource](../gift_cards/classes/gift_cards.GiftCardsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/index.mdx b/www/apps/docs/content/references/js-client/modules/index.mdx new file mode 100644 index 0000000000..38936609fd --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/index.mdx @@ -0,0 +1,355 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# index + +## References + +### AddressesResource + +Re-exports [AddressesResource](../addresses/classes/addresses.AddressesResource.mdx) + +___ + +### Admin + +Re-exports [Admin](../admin/classes/admin.Admin.mdx) + +___ + +### AdminAuthResource + +Re-exports [AdminAuthResource](../admin_auth/classes/admin_auth.AdminAuthResource.mdx) + +___ + +### AdminBatchJobsResource + +Re-exports [AdminBatchJobsResource](../admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx) + +___ + +### AdminCollectionsResource + +Re-exports [AdminCollectionsResource](../admin_collections/classes/admin_collections.AdminCollectionsResource.mdx) + +___ + +### AdminCurrenciesResource + +Re-exports [AdminCurrenciesResource](../admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx) + +___ + +### AdminCustomResource + +Re-exports [AdminCustomResource](../admin_custom/classes/admin_custom.AdminCustomResource.mdx) + +___ + +### AdminCustomerGroupsResource + +Re-exports [AdminCustomerGroupsResource](../admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx) + +___ + +### AdminCustomersResource + +Re-exports [AdminCustomersResource](../admin_customers/classes/admin_customers.AdminCustomersResource.mdx) + +___ + +### AdminDiscountsResource + +Re-exports [AdminDiscountsResource](../admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx) + +___ + +### AdminDraftOrdersResource + +Re-exports [AdminDraftOrdersResource](../admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx) + +___ + +### AdminGiftCardsResource + +Re-exports [AdminGiftCardsResource](../admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx) + +___ + +### AdminInvitesResource + +Re-exports [AdminInvitesResource](../admin_invites/classes/admin_invites.AdminInvitesResource.mdx) + +___ + +### AdminNotesResource + +Re-exports [AdminNotesResource](../admin_notes/classes/admin_notes.AdminNotesResource.mdx) + +___ + +### AdminNotificationsResource + +Re-exports [AdminNotificationsResource](../admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx) + +___ + +### AdminOrderEditsResource + +Re-exports [AdminOrderEditsResource](../admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx) + +___ + +### AdminOrdersResource + +Re-exports [AdminOrdersResource](../admin_orders/classes/admin_orders.AdminOrdersResource.mdx) + +___ + +### AdminPaymentCollectionsResource + +Re-exports [AdminPaymentCollectionsResource](../admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx) + +___ + +### AdminPaymentsResource + +Re-exports [AdminPaymentsResource](../admin_payments/classes/admin_payments.AdminPaymentsResource.mdx) + +___ + +### AdminPriceListResource + +Re-exports [AdminPriceListResource](../admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx) + +___ + +### AdminProductCategoriesResource + +Re-exports [AdminProductCategoriesResource](../admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx) + +___ + +### AdminProductTagsResource + +Re-exports [AdminProductTagsResource](../admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx) + +___ + +### AdminProductTypesResource + +Re-exports [AdminProductTypesResource](../admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx) + +___ + +### AdminProductsResource + +Re-exports [AdminProductsResource](../admin_products/classes/admin_products.AdminProductsResource.mdx) + +___ + +### AdminPublishableApiKeyResource + +Re-exports [AdminPublishableApiKeyResource](../admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx) + +___ + +### AdminRegionsResource + +Re-exports [AdminRegionsResource](../admin_regions/classes/admin_regions.AdminRegionsResource.mdx) + +___ + +### AdminReturnReasonsResource + +Re-exports [AdminReturnReasonsResource](../admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx) + +___ + +### AdminReturnsResource + +Re-exports [AdminReturnsResource](../admin_returns/classes/admin_returns.AdminReturnsResource.mdx) + +___ + +### AdminSalesChannelsResource + +Re-exports [AdminSalesChannelsResource](../admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx) + +___ + +### AdminShippingOptionsResource + +Re-exports [AdminShippingOptionsResource](../admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx) + +___ + +### AdminShippingProfilesResource + +Re-exports [AdminShippingProfilesResource](../admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx) + +___ + +### AdminStockLocationsResource + +Re-exports [AdminStockLocationsResource](../admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx) + +___ + +### AdminStoresResource + +Re-exports [AdminStoresResource](../admin_store/classes/admin_store.AdminStoresResource.mdx) + +___ + +### AdminSwapsResource + +Re-exports [AdminSwapsResource](../admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx) + +___ + +### AdminTaxRatesResource + +Re-exports [AdminTaxRatesResource](../admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx) + +___ + +### AdminUploadsResource + +Re-exports [AdminUploadsResource](../admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx) + +___ + +### AdminUsersResource + +Re-exports [AdminUsersResource](../admin_users/classes/admin_users.AdminUsersResource.mdx) + +___ + +### AdminVariantsResource + +Re-exports [AdminVariantsResource](../admin_variants/classes/admin_variants.AdminVariantsResource.mdx) + +___ + +### AuthResource + +Re-exports [AuthResource](../auth/classes/auth.AuthResource.mdx) + +___ + +### CartsResource + +Re-exports [CartsResource](../carts/classes/carts.CartsResource.mdx) + +___ + +### CollectionsResource + +Re-exports [CollectionsResource](../collections/classes/collections.CollectionsResource.mdx) + +___ + +### CustomersResource + +Renames and re-exports [CustomerResource](../customers/classes/customers.CustomerResource.mdx) + +___ + +### GiftCardsResource + +Re-exports [GiftCardsResource](../gift_cards/classes/gift_cards.GiftCardsResource.mdx) + +___ + +### LineItemsResource + +Re-exports [LineItemsResource](../line_items/classes/line_items.LineItemsResource.mdx) + +___ + +### OrderEditsResource + +Re-exports [OrderEditsResource](../order_edits/classes/order_edits.OrderEditsResource.mdx) + +___ + +### OrdersResource + +Re-exports [OrdersResource](../orders/classes/orders.OrdersResource.mdx) + +___ + +### PaymentCollectionsResource + +Re-exports [PaymentCollectionsResource](../payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx) + +___ + +### PaymentMethodsResource + +Re-exports [PaymentMethodsResource](../payment_methods/classes/payment_methods.PaymentMethodsResource.mdx) + +___ + +### ProductCategoriesResource + +Re-exports [ProductCategoriesResource](../product_categories/classes/product_categories.ProductCategoriesResource.mdx) + +___ + +### ProductTagsResource + +Re-exports [ProductTagsResource](../product_tags/classes/product_tags.ProductTagsResource.mdx) + +___ + +### ProductTypesResource + +Re-exports [ProductTypesResource](../product_types/classes/product_types.ProductTypesResource.mdx) + +___ + +### ProductVariantsResource + +Re-exports [ProductVariantsResource](../product_variants/classes/product_variants.ProductVariantsResource.mdx) + +___ + +### ProductsResource + +Re-exports [ProductsResource](../products/classes/products.ProductsResource.mdx) + +___ + +### RegionsResource + +Re-exports [RegionsResource](../regions/classes/regions.RegionsResource.mdx) + +___ + +### ReturnReasonsResource + +Re-exports [ReturnReasonsResource](../return_reasons/classes/return_reasons.ReturnReasonsResource.mdx) + +___ + +### ReturnsResource + +Re-exports [ReturnsResource](../returns/classes/returns.ReturnsResource.mdx) + +___ + +### ShippingOptionsResource + +Re-exports [ShippingOptionsResource](../shipping_options/classes/shipping_options.ShippingOptionsResource.mdx) + +___ + +### SwapsResource + +Re-exports [SwapsResource](../swaps/classes/swaps.SwapsResource.mdx) 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 deleted file mode 100644 index 06a979ddea..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-1.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Module: internal - -## Enumerations - -- [UserRoles](../enums/internal-1.UserRoles.md) - -## 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 - -### AdminAuthRes - -Ƭ **AdminAuthRes**: `Object` - -**`Schema`** - -AdminAuthRes -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/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 deleted file mode 100644 index aa273bb437..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-10.md +++ /dev/null @@ -1,484 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Module: internal - -## 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 - -### AdminCreateUploadPayload - -Ƭ **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 | -| :------ | :------ | -| `prototype` | [`File`](internal-10.md#file) | - -#### Defined in - -docs-util/node_modules/typescript/lib/lib.dom.d.ts:8260 - -docs-util/node_modules/typescript/lib/lib.dom.d.ts:8269 - -___ - -### ReadableByteStreamController - -• **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 - -docs-util/node_modules/typescript/lib/lib.dom.d.ts:18464 - -docs-util/node_modules/typescript/lib/lib.dom.d.ts:18477 - -___ - -### ReadableStream - -• **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 - -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 deleted file mode 100644 index fdb39cbaee..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-11.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Module: internal - -## Type Aliases - -### AdminCreateUserPayload - -Ƭ **AdminCreateUserPayload**: [`Omit`](internal-1.md#omit)<[`AdminCreateUserRequest`](../classes/internal-8.internal.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-11.md#createuserroles) } - -#### Defined in - -[packages/medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L31) - -___ - -### AdminUpdateUserPayload - -Ƭ **AdminUpdateUserPayload**: [`Omit`](internal-1.md#omit)<[`AdminUpdateUserRequest`](../classes/internal-8.internal.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-11.md#updateuserroles) } - -#### Defined in - -[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 deleted file mode 100644 index ce1453a92a..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-12.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Module: internal - -## Classes - -- [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 - -### AxiosRequestHeaders - -Ƭ **AxiosRequestHeaders**: [`Record`](internal.md#record)<`string`, `string`\> - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:3 - -___ - -### AxiosResponseHeaders - -Ƭ **AxiosResponseHeaders**: [`Record`](internal.md#record)<`string`, `string`\> & { `set-cookie?`: `string`[] } - -#### Defined in - -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-2.md b/www/apps/docs/content/references/js-client/modules/internal-2.md deleted file mode 100644 index eebfc9e006..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-2.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Module: internal - -## Enumerations - -- [BatchJobStatus](../enums/internal-2.BatchJobStatus.md) - -## Classes - -- [AdminGetBatchPaginationParams](../classes/internal-2.AdminGetBatchPaginationParams.md) -- [AdminGetBatchParams](../classes/internal-2.AdminGetBatchParams.md) -- [AdminPostBatchesReq](../classes/internal-2.AdminPostBatchesReq.md) -- [BatchJob](../classes/internal-2.BatchJob.md) -- [DateComparisonOperator](../classes/internal-2.DateComparisonOperator.md) - -## Type Aliases - -### AdminBatchJobListRes - -Ƭ **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 - -packages/medusa/dist/api/routes/admin/batch/index.d.ts:42 - -___ - -### AdminBatchJobRes - -Ƭ **AdminBatchJobRes**: `Object` - -**`Schema`** - -AdminBatchJobRes -type: object -required: - - batch_job -properties: - batch_job: - description: Batch job details. - $ref: "#/components/schemas/BatchJob" - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `batch_job` | [`BatchJob`](../classes/internal-2.BatchJob.md) | - -#### Defined in - -packages/medusa/dist/api/routes/admin/batch/index.d.ts:15 - -___ - -### BatchJobResultError - -Ƭ **BatchJobResultError**: `Object` - -#### Index signature - -▪ [key: `string`]: `unknown` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `code` | `string` \| `number` | -| `message` | `string` | - -#### Defined in - -packages/medusa/dist/types/batch-job.d.ts:18 - -___ - -### BatchJobResultStatDescriptor - -Ƭ **BatchJobResultStatDescriptor**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `message` | `string` | -| `name` | `string` | - -#### Defined in - -packages/medusa/dist/types/batch-job.d.ts:23 - -___ - -### PaginatedResponse - -Ƭ **PaginatedResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `count` | `number` | -| `limit` | `number` | -| `offset` | `number` | - -#### Defined in - -packages/medusa/dist/types/common.d.ts:70 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 deleted file mode 100644 index 5795db69c5..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-3.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -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-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 - -packages/medusa/dist/api/routes/admin/collections/index.d.ts:32 - -___ - -### AdminCollectionsRes - -Ƭ **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-3.ProductCollection.md) | - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/index.d.ts:97 - -___ - -### AdminDeleteProductsFromCollectionRes - -Ƭ **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 | -| :------ | :------ | -| `id` | `string` | -| `object` | `string` | -| `removed_products` | `string`[] | - -#### Defined in - -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-4.md b/www/apps/docs/content/references/js-client/modules/internal-4.md deleted file mode 100644 index 105f8a1a3f..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-4.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Module: internal - -## Classes - -- [AdminGetCurrenciesParams](../classes/internal-4.AdminGetCurrenciesParams.md) -- [AdminPostCurrenciesCurrencyReq](../classes/internal-4.AdminPostCurrenciesCurrencyReq.md) -- [FindPaginationParams](../classes/internal-4.FindPaginationParams.md) - -## Type Aliases - -### AdminCurrenciesListRes - -Ƭ **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 - -packages/medusa/dist/api/routes/admin/currencies/index.d.ts:29 - -___ - -### AdminCurrenciesRes - -Ƭ **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-3.Currency.md) | - -#### Defined in - -packages/medusa/dist/api/routes/admin/currencies/index.d.ts:42 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 deleted file mode 100644 index e5ce3e44ec..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-5.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Module: internal - -## Interfaces - -- [RequestOptions](../interfaces/internal-5.RequestOptions.md) 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 deleted file mode 100644 index 8d8cf2115b..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-6.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Module: internal - -## Classes - -- [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 - -### AdminCustomerGroupsListRes - -Ƭ **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_group` | [`CustomerGroup`](../classes/internal-3.CustomerGroup.md) | - -#### Defined in - -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.md b/www/apps/docs/content/references/js-client/modules/internal-7.md deleted file mode 100644 index 877d155b60..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-7.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Module: internal - -## Classes - -- [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 - -### AdminCustomersListRes - -Ƭ **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 | -| :------ | :------ | -| `customer` | [`Customer`](../classes/internal-3.Customer.md) | - -#### Defined in - -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 deleted file mode 100644 index 34660f1776..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-8.EventEmitter.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 deleted file mode 100644 index d63551bad2..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-8.internal-1.md +++ /dev/null @@ -1,643 +0,0 @@ ---- -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 deleted file mode 100644 index 6ea03b24f0..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-8.internal-2.finished.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 deleted file mode 100644 index bd28198e97..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-8.internal-2.md +++ /dev/null @@ -1,835 +0,0 @@ ---- -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 deleted file mode 100644 index a7d4dfc892..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-8.internal-2.pipeline.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -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 deleted file mode 100644 index 5d91bec167..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-8.internal-3.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -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 deleted file mode 100644 index b55f699fc9..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-8.internal-4.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -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 deleted file mode 100644 index 5e2da612a7..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-8.internal.md +++ /dev/null @@ -1,9655 +0,0 @@ ---- -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 deleted file mode 100644 index 5bb12c9e3a..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-8.md +++ /dev/null @@ -1,7138 +0,0 @@ ---- -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 - -- [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 - -### AddOrderEditLineItemInput - -Ƭ **AddOrderEditLineItemInput**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | -| `quantity` | `number` | -| `variant_id` | `string` | - -#### Defined in - -packages/medusa/dist/types/order-edit.d.ts:6 - -___ - -### AdjustmentContext - -Ƭ **AdjustmentContext**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `variant` | { `product_id`: `string` } | -| `variant.product_id` | `string` | - -#### Defined in - -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 deleted file mode 100644 index e566a767cf..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-9.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Module: internal - -## Type Aliases - -### AdminPostInvitesPayload - -Ƭ **AdminPostInvitesPayload**: [`Omit`](internal-1.md#omit)<[`AdminPostInvitesReq`](../classes/internal-8.internal.AdminPostInvitesReq.md), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](internal-9.md#inviteuserrolesenum) } - -#### Defined in - -[packages/medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L47) - -___ - -### InviteUserRolesEnum - -Ƭ **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\` - -#### Defined in - -[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 deleted file mode 100644 index bb7700f2b8..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Module: internal - -## Classes - -- [AddressCreatePayload](../classes/internal.AddressCreatePayload.md) -- [AddressPayload](../classes/internal.AddressPayload.md) -- [StorePostCustomersCustomerAddressesAddressReq](../classes/internal.StorePostCustomersCustomerAddressesAddressReq.md) -- [StorePostCustomersCustomerAddressesReq](../classes/internal.StorePostCustomersCustomerAddressesReq.md) - -## Type Aliases - -### Record - -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } - -Construct a type with a set of properties K of type T - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends keyof `any` | -| `T` | `T` | - -#### Defined in - -docs-util/node_modules/typescript/lib/lib.es5.d.ts:1599 diff --git a/www/apps/docs/content/references/js-client/modules/line_items.mdx b/www/apps/docs/content/references/js-client/modules/line_items.mdx new file mode 100644 index 0000000000..c2e151a4f4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/line_items.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# line-items + +## Classes + +- [LineItemsResource](../line_items/classes/line_items.LineItemsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/order_edits.mdx b/www/apps/docs/content/references/js-client/modules/order_edits.mdx new file mode 100644 index 0000000000..4ecaf34416 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/order_edits.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# order-edits + +## Classes + +- [OrderEditsResource](../order_edits/classes/order_edits.OrderEditsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/orders.mdx b/www/apps/docs/content/references/js-client/modules/orders.mdx new file mode 100644 index 0000000000..23d2a8a748 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/orders.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# orders + +## Classes + +- [OrdersResource](../orders/classes/orders.OrdersResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/payment_collections.mdx b/www/apps/docs/content/references/js-client/modules/payment_collections.mdx new file mode 100644 index 0000000000..f6732b1e78 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/payment_collections.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# payment-collections + +## Classes + +- [PaymentCollectionsResource](../payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/payment_methods.mdx b/www/apps/docs/content/references/js-client/modules/payment_methods.mdx new file mode 100644 index 0000000000..3382940193 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/payment_methods.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# payment-methods + +## Classes + +- [PaymentMethodsResource](../payment_methods/classes/payment_methods.PaymentMethodsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/product_categories.mdx b/www/apps/docs/content/references/js-client/modules/product_categories.mdx new file mode 100644 index 0000000000..7c4842a8af --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/product_categories.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# product-categories + +## Classes + +- [ProductCategoriesResource](../product_categories/classes/product_categories.ProductCategoriesResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/product_tags.mdx b/www/apps/docs/content/references/js-client/modules/product_tags.mdx new file mode 100644 index 0000000000..01ce96633e --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/product_tags.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# product-tags + +## Classes + +- [ProductTagsResource](../product_tags/classes/product_tags.ProductTagsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/product_types.mdx b/www/apps/docs/content/references/js-client/modules/product_types.mdx new file mode 100644 index 0000000000..32c2720281 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/product_types.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# product-types + +## Classes + +- [ProductTypesResource](../product_types/classes/product_types.ProductTypesResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/product_variants.mdx b/www/apps/docs/content/references/js-client/modules/product_variants.mdx new file mode 100644 index 0000000000..23b30b4517 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/product_variants.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# product-variants + +## Classes + +- [ProductVariantsResource](../product_variants/classes/product_variants.ProductVariantsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/products.mdx b/www/apps/docs/content/references/js-client/modules/products.mdx new file mode 100644 index 0000000000..d766149eed --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/products.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# products + +## Classes + +- [ProductsResource](../products/classes/products.ProductsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/regions.mdx b/www/apps/docs/content/references/js-client/modules/regions.mdx new file mode 100644 index 0000000000..a2a9a69956 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/regions.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# regions + +## Classes + +- [RegionsResource](../regions/classes/regions.RegionsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/return_reasons.mdx b/www/apps/docs/content/references/js-client/modules/return_reasons.mdx new file mode 100644 index 0000000000..13e15376ef --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/return_reasons.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# return-reasons + +## Classes + +- [ReturnReasonsResource](../return_reasons/classes/return_reasons.ReturnReasonsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/returns.mdx b/www/apps/docs/content/references/js-client/modules/returns.mdx new file mode 100644 index 0000000000..423bbb40ed --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/returns.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# returns + +## Classes + +- [ReturnsResource](../returns/classes/returns.ReturnsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/shipping_options.mdx b/www/apps/docs/content/references/js-client/modules/shipping_options.mdx new file mode 100644 index 0000000000..541042defa --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/shipping_options.mdx @@ -0,0 +1,11 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# shipping-options + +## Classes + +- [ShippingOptionsResource](../shipping_options/classes/shipping_options.ShippingOptionsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/modules/swaps.mdx b/www/apps/docs/content/references/js-client/modules/swaps.mdx new file mode 100644 index 0000000000..981cfc6d21 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/swaps.mdx @@ -0,0 +1,15 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# swaps + +## Modules + +- [internal](../swaps/modules/swaps.internal.mdx) + +## Classes + +- [SwapsResource](../swaps/classes/swaps.SwapsResource.mdx) diff --git a/www/apps/docs/content/references/js-client/order_edits/classes/order_edits.OrderEditsResource.mdx b/www/apps/docs/content/references/js-client/order_edits/classes/order_edits.OrderEditsResource.mdx new file mode 100644 index 0000000000..fca3e9bde2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/order_edits/classes/order_edits.OrderEditsResource.mdx @@ -0,0 +1,170 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderEditsResource + +[order-edits](../../modules/order_edits.mdx).OrderEditsResource + +## Methods + +### complete + +▸ **complete**(`id`, `customHeaders?`): `Promise`<`any`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### decline + +▸ **decline**(`id`, `payload`, `customHeaders?`): `Promise`<`any`\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +`Promise`<`any`\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "any", + "type": "`any`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordereditsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordereditsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreOrderEditsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/orders/classes/orders.OrdersResource.mdx b/www/apps/docs/content/references/js-client/orders/classes/orders.OrdersResource.mdx new file mode 100644 index 0000000000..80431bb498 --- /dev/null +++ b/www/apps/docs/content/references/js-client/orders/classes/orders.OrdersResource.mdx @@ -0,0 +1,266 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrdersResource + +[orders](../../modules/orders.mdx).OrdersResource + +## Methods + +### confirmRequest + +▸ **confirmRequest**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) + + + +#### Description + +Grant access to a list of orders + +___ + +### lookupOrder + +▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Look up an order using order details + +___ + +### requestCustomerOrders + +▸ **requestCustomerOrders**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) + + + +#### Description + +Request access to a list of orders + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves an order + +___ + +### retrieveByCartId + +▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordersres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordersres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreOrdersRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves an order by cart id diff --git a/www/apps/docs/content/references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx b/www/apps/docs/content/references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx new file mode 100644 index 0000000000..8f4a06be6e --- /dev/null +++ b/www/apps/docs/content/references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx @@ -0,0 +1,363 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentCollectionsResource + +[payment-collections](../../modules/payment_collections.mdx).PaymentCollectionsResource + +## Methods + +### authorizePaymentSession + +▸ **authorizePaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StorePaymentCollectionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### authorizePaymentSessionsBatch + +▸ **authorizePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StorePaymentCollectionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### managePaymentSession + +▸ **managePaymentSession**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StorePaymentCollectionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### managePaymentSessionsBatch + +▸ **managePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StorePaymentCollectionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### refreshPaymentSession + +▸ **refreshPaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsSessionRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionssessionres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsSessionRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionssessionres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StorePaymentCollectionsSessionRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StorePaymentCollectionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource.mdx b/www/apps/docs/content/references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource.mdx new file mode 100644 index 0000000000..cc47b3b57b --- /dev/null +++ b/www/apps/docs/content/references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource.mdx @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentMethodsResource + +[payment-methods](../../modules/payment_methods.mdx).PaymentMethodsResource + +## Methods + +### list + +▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomerslistpaymentmethodsres)\> + +Lists customer payment methods + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomerslistpaymentmethodsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreCustomersListPaymentMethodsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/product_categories/classes/product_categories.ProductCategoriesResource.mdx b/www/apps/docs/content/references/js-client/product_categories/classes/product_categories.ProductCategoriesResource.mdx new file mode 100644 index 0000000000..32dd65a960 --- /dev/null +++ b/www/apps/docs/content/references/js-client/product_categories/classes/product_categories.ProductCategoriesResource.mdx @@ -0,0 +1,127 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductCategoriesResource + +[product-categories](../../modules/product_categories.mdx).ProductCategoriesResource + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetProductCategoriesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetproductcategoriesres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetProductCategoriesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetproductcategoriesres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreGetProductCategoriesRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_categories`: [`ProductCategory`](../../internal/classes/admin_collections.internal.ProductCategory.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a list of product categories + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetproductcategoriescategoryres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetproductcategoriescategoryres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreGetProductCategoriesCategoryRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a single product category diff --git a/www/apps/docs/content/references/js-client/product_tags/classes/product_tags.ProductTagsResource.mdx b/www/apps/docs/content/references/js-client/product_tags/classes/product_tags.ProductTagsResource.mdx new file mode 100644 index 0000000000..b1a0f02563 --- /dev/null +++ b/www/apps/docs/content/references/js-client/product_tags/classes/product_tags.ProductTagsResource.mdx @@ -0,0 +1,64 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductTagsResource + +[product-tags](../../modules/product_tags.mdx).ProductTagsResource + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductTagsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproducttagslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductTagsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproducttagslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreProductTagsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_tags`: [`ProductTag`](../../internal/classes/admin_collections.internal.ProductTag.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a list of product tags diff --git a/www/apps/docs/content/references/js-client/product_types/classes/product_types.ProductTypesResource.mdx b/www/apps/docs/content/references/js-client/product_types/classes/product_types.ProductTypesResource.mdx new file mode 100644 index 0000000000..57a2c4e2e5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/product_types/classes/product_types.ProductTypesResource.mdx @@ -0,0 +1,64 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductTypesResource + +[product-types](../../modules/product_types.mdx).ProductTypesResource + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductTypesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproducttypeslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductTypesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproducttypeslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreProductTypesListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_types`: [`ProductType`](../../internal/classes/admin_collections.internal.ProductType.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a list of product types diff --git a/www/apps/docs/content/references/js-client/product_variants/classes/product_variants.ProductVariantsResource.mdx b/www/apps/docs/content/references/js-client/product_variants/classes/product_variants.ProductVariantsResource.mdx new file mode 100644 index 0000000000..e82a4a019b --- /dev/null +++ b/www/apps/docs/content/references/js-client/product_variants/classes/product_variants.ProductVariantsResource.mdx @@ -0,0 +1,119 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantsResource + +[product-variants](../../modules/product_variants.mdx).ProductVariantsResource + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreVariantsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storevariantslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreVariantsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storevariantslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreVariantsListRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a list of of Product Variants + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreVariantsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storevariantsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreVariantsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storevariantsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreVariantsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a single product variant diff --git a/www/apps/docs/content/references/js-client/products/classes/products.ProductsResource.mdx b/www/apps/docs/content/references/js-client/products/classes/products.ProductsResource.mdx new file mode 100644 index 0000000000..0188019a01 --- /dev/null +++ b/www/apps/docs/content/references/js-client/products/classes/products.ProductsResource.mdx @@ -0,0 +1,187 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductsResource + +[products](../../modules/products.mdx).ProductsResource + +## Properties + + + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproductslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproductslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreProductsListRes", + "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `products`: [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a list of products + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproductsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproductsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreProductsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a single Product + +___ + +### search + +▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePostSearchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepostsearchres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePostSearchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepostsearchres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StorePostSearchRes", + "type": "{ `hits`: `unknown`[] } & Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Searches for products diff --git a/www/apps/docs/content/references/js-client/regions/classes/regions.RegionsResource.mdx b/www/apps/docs/content/references/js-client/regions/classes/regions.RegionsResource.mdx new file mode 100644 index 0000000000..16f629d074 --- /dev/null +++ b/www/apps/docs/content/references/js-client/regions/classes/regions.RegionsResource.mdx @@ -0,0 +1,111 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RegionsResource + +[regions](../../modules/regions.mdx).RegionsResource + +## Methods + +### list + +▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreRegionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeregionslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreRegionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeregionslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreRegionsListRes", + "type": "[`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `regions`: [`Region`](../../internal/classes/admin_collections.internal.Region.mdx)[] }", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a list of regions + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreRegionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeregionsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreRegionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeregionsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreRegionsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a region diff --git a/www/apps/docs/content/references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource.mdx b/www/apps/docs/content/references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource.mdx new file mode 100644 index 0000000000..39702299b1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource.mdx @@ -0,0 +1,109 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnReasonsResource + +[return-reasons](../../modules/return_reasons.mdx).ReturnReasonsResource + +## Methods + +### list + +▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreReturnReasonsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storereturnreasonslistres)\> + +Lists return reasons defined in Medusa Admin + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreReturnReasonsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storereturnreasonslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreReturnReasonsListRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storereturnreasonsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storereturnreasonsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreReturnReasonsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a single Return Reason diff --git a/www/apps/docs/content/references/js-client/returns/classes/returns.ReturnsResource.mdx b/www/apps/docs/content/references/js-client/returns/classes/returns.ReturnsResource.mdx new file mode 100644 index 0000000000..4a59ed41ff --- /dev/null +++ b/www/apps/docs/content/references/js-client/returns/classes/returns.ReturnsResource.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnsResource + +[returns](../../modules/returns.mdx).ReturnsResource + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreReturnsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storereturnsres)\> + +Creates a return request + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreReturnsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storereturnsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreReturnsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource.mdx b/www/apps/docs/content/references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource.mdx new file mode 100644 index 0000000000..bc6b485998 --- /dev/null +++ b/www/apps/docs/content/references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource.mdx @@ -0,0 +1,119 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingOptionsResource + +[shipping-options](../../modules/shipping_options.mdx).ShippingOptionsResource + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeshippingoptionslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeshippingoptionslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreShippingOptionsListRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Lists shipping options available + +___ + +### listCartOptions + +▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeshippingoptionslistres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeshippingoptionslistres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreShippingOptionsListRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Lists shipping options available for a cart diff --git a/www/apps/docs/content/references/js-client/swaps/classes/swaps.SwapsResource.mdx b/www/apps/docs/content/references/js-client/swaps/classes/swaps.SwapsResource.mdx new file mode 100644 index 0000000000..e359c885e9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/swaps/classes/swaps.SwapsResource.mdx @@ -0,0 +1,119 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SwapsResource + +[swaps](../../modules/swaps.mdx).SwapsResource + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreSwapsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Creates a swap from a cart + +___ + +### retrieveByCartId + +▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\> + +#### Parameters + +", + "description": "", + "optional": false, + "defaultValue": "`{}`", + "children": [] + } +]} /> + +#### Returns + +[`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\> + +", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "StoreSwapsRes", + "type": "`object`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> + +#### Description + +Retrieves a swap by cart id diff --git a/www/apps/docs/content/references/js-client/swaps/modules/swaps.internal.mdx b/www/apps/docs/content/references/js-client/swaps/modules/swaps.internal.mdx new file mode 100644 index 0000000000..371eb86449 --- /dev/null +++ b/www/apps/docs/content/references/js-client/swaps/modules/swaps.internal.mdx @@ -0,0 +1,101 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# internal + +## Classes + +- [Axios](../../internal/classes/swaps.internal.Axios.mdx) +- [Client](../../internal/classes/swaps.internal.Client.mdx) + +## Interfaces + +- [AxiosAdapter](../../internal/interfaces/swaps.internal.AxiosAdapter.mdx) +- [AxiosBasicCredentials](../../internal/interfaces/swaps.internal.AxiosBasicCredentials.mdx) +- [AxiosDefaults](../../internal/interfaces/swaps.internal.AxiosDefaults.mdx) +- [AxiosError](../../internal/interfaces/swaps.internal.AxiosError.mdx) +- [AxiosInstance](../../internal/interfaces/swaps.internal.AxiosInstance.mdx) +- [AxiosInterceptorManager](../../internal/interfaces/swaps.internal.AxiosInterceptorManager.mdx) +- [AxiosPromise](../../internal/interfaces/swaps.internal.AxiosPromise.mdx) +- [AxiosProxyConfig](../../internal/interfaces/swaps.internal.AxiosProxyConfig.mdx) +- [AxiosRequestTransformer](../../internal/interfaces/swaps.internal.AxiosRequestTransformer.mdx) +- [AxiosResponse](../../internal/interfaces/swaps.internal.AxiosResponse.mdx) +- [AxiosResponseTransformer](../../internal/interfaces/swaps.internal.AxiosResponseTransformer.mdx) +- [Cancel](../../internal/interfaces/swaps.internal.Cancel.mdx) +- [CancelToken](../../internal/interfaces/swaps.internal.CancelToken.mdx) +- [Config](../../internal/interfaces/swaps.internal.Config.mdx) +- [HTTPResponse](../../internal/interfaces/swaps.internal.HTTPResponse.mdx) +- [HeadersDefaults](../../internal/interfaces/swaps.internal.HeadersDefaults.mdx) +- [RetryConfig](../../internal/interfaces/swaps.internal.RetryConfig.mdx) +- [TransitionalOptions](../../internal/interfaces/swaps.internal.TransitionalOptions.mdx) + +## Type Aliases + +### AxiosRequestHeaders + +Ƭ **AxiosRequestHeaders**: Record<`string`, `string`\> + +___ + +### AxiosResponseHeaders + +Ƭ **AxiosResponseHeaders**: Record<`string`, `string`\> & { `set-cookie?`: `string`[] } + +___ + +### Method + +Ƭ **Method**: ``"get"`` \| ``"GET"`` \| ``"delete"`` \| ``"DELETE"`` \| ``"head"`` \| ``"HEAD"`` \| ``"options"`` \| ``"OPTIONS"`` \| ``"post"`` \| ``"POST"`` \| ``"put"`` \| ``"PUT"`` \| ``"patch"`` \| ``"PATCH"`` \| ``"purge"`` \| ``"PURGE"`` \| ``"link"`` \| ``"LINK"`` \| ``"unlink"`` \| ``"UNLINK"`` + +___ + +### RequestMethod + +Ƭ **RequestMethod**: ``"DELETE"`` \| ``"POST"`` \| ``"GET"`` + +___ + +### Response + +Ƭ **Response**<`T`\>: `T` & { `response`: [`HTTPResponse`](../../internal/interfaces/swaps.internal.HTTPResponse.mdx) } + +#### Type parameters + + + +___ + +### ResponsePromise + +Ƭ **ResponsePromise**<`T`\>: `Promise`<[`Response`](swaps.internal.mdx#response)<`T`\>\> + +#### Type parameters + + + +___ + +### ResponseType + +Ƭ **ResponseType**: ``"arraybuffer"`` \| ``"blob"`` \| ``"document"`` \| ``"json"`` \| ``"text"`` \| ``"stream"`` diff --git a/www/apps/docs/sidebars.js b/www/apps/docs/sidebars.js index a1659c2b5b..ee0bd9fb45 100644 --- a/www/apps/docs/sidebars.js +++ b/www/apps/docs/sidebars.js @@ -2630,164 +2630,204 @@ module.exports = { collapsed: true, link: { type: "doc", - id: "references/js-client/classes/Admin", + id: "references/js-client/admin/classes/admin.Admin", }, items: [ { type: "doc", - id: "references/js-client/classes/AdminAuthResource", + id: "references/js-client/admin_auth/classes/admin_auth.AdminAuthResource", label: "auth", }, { type: "doc", - id: "references/js-client/classes/AdminBatchJobsResource", + id: "references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource", label: "batchJobs", }, { type: "doc", - id: "references/js-client/classes/AdminCollectionsResource", + id: "references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource", label: "collections", }, { type: "doc", - id: "references/js-client/classes/AdminCurrenciesResource", + id: "references/js-client/admin_currencies/classes/admin_currencies.AdminCurrenciesResource", label: "currencies", }, { type: "doc", - id: "references/js-client/classes/AdminCustomerGroupsResource", + id: "references/js-client/admin_custom/classes/admin_custom.AdminCustomResource", + label: "custom", + }, + { + type: "doc", + id: "references/js-client/admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource", label: "customerGroups", }, { type: "doc", - id: "references/js-client/classes/AdminCustomersResource", + id: "references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource", label: "customers", }, { type: "doc", - id: "references/js-client/classes/AdminDiscountsResource", + id: "references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource", label: "discounts", }, { type: "doc", - id: "references/js-client/classes/AdminDraftOrdersResource", + id: "references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource", label: "draftOrders", }, { type: "doc", - id: "references/js-client/classes/AdminGiftCardsResource", + id: "references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource", label: "giftCards", }, { type: "doc", - id: "references/js-client/classes/AdminInvitesResource", + id: "references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource", + label: "inventoryItems", + }, + { + type: "doc", + id: "references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource", label: "invites", }, { type: "doc", - id: "references/js-client/classes/AdminNotesResource", + id: "references/js-client/admin_notes/classes/admin_notes.AdminNotesResource", label: "notes", }, { type: "doc", - id: "references/js-client/classes/AdminNotificationsResource", + id: "references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource", label: "notifications", }, { type: "doc", - id: "references/js-client/classes/AdminOrdersResource", - label: "orders", - }, - { - type: "doc", - id: "references/js-client/classes/AdminOrderEditsResource", + id: "references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource", label: "orderEdits", }, { type: "doc", - id: "references/js-client/classes/AdminPriceListResource", + id: "references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource", + label: "orders", + }, + { + type: "doc", + id: "references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource", + label: "paymentCollections", + }, + { + type: "doc", + id: "references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource", + label: "payments", + }, + { + type: "doc", + id: "references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource", label: "priceLists", }, { type: "doc", - id: "references/js-client/classes/AdminProductsResource", - label: "products", + id: "references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource", + label: "productCategories", }, { type: "doc", - id: "references/js-client/classes/AdminProductTagsResource", + id: "references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource", label: "productTags", }, { type: "doc", - id: "references/js-client/classes/AdminProductTypesResource", + id: "references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource", label: "productTypes", }, { type: "doc", - id: "references/js-client/classes/AdminRegionsResource", + id: "references/js-client/admin_products/classes/admin_products.AdminProductsResource", + label: "products", + }, + { + type: "doc", + id: "references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource", + label: "publishableApiKeys", + }, + { + type: "doc", + id: "references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource", label: "regions", }, { type: "doc", - id: "references/js-client/classes/AdminReturnReasonsResource", + id: "references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource", + label: "reservations", + }, + { + type: "doc", + id: "references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource", label: "returnReasons", }, { type: "doc", - id: "references/js-client/classes/AdminReturnsResource", + id: "references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource", label: "returns", }, { type: "doc", - id: "references/js-client/classes/AdminSalesChannelsResource", + id: "references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource", label: "salesChannels", }, { type: "doc", - id: "references/js-client/classes/AdminShippingOptionsResource", + id: "references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource", label: "shippingOptions", }, { type: "doc", - id: "references/js-client/classes/AdminShippingProfilesResource", + id: "references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource", label: "shippingProfiles", }, { type: "doc", - id: "references/js-client/classes/AdminStoresResource", + id: "references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource", + label: "stockLocations", + }, + { + type: "doc", + id: "references/js-client/admin_store/classes/admin_store.AdminStoresResource", label: "store", }, { type: "doc", - id: "references/js-client/classes/AdminSwapsResource", + id: "references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource", label: "swaps", }, { type: "doc", - id: "references/js-client/classes/AdminTaxRatesResource", + id: "references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource", label: "taxRates", }, { type: "doc", - id: "references/js-client/classes/AdminUploadsResource", + id: "references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource", label: "uploads", }, { type: "doc", - id: "references/js-client/classes/AdminUsersResource", + id: "references/js-client/admin_users/classes/admin_users.AdminUsersResource", label: "users", }, { type: "doc", - id: "references/js-client/classes/AdminVariantsResource", + id: "references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource", label: "variants", }, ], }, { type: "doc", - id: "references/js-client/classes/AuthResource", + id: "references/js-client/auth/classes/auth.AuthResource", label: "auth", }, { @@ -2795,20 +2835,20 @@ module.exports = { label: "carts", link: { type: "doc", - id: "references/js-client/classes/CartsResource", + id: "references/js-client/carts/classes/carts.CartsResource", }, collapsed: true, items: [ { type: "doc", - id: "references/js-client/classes/LineItemsResource", + id: "references/js-client/line_items/classes/line_items.LineItemsResource", label: "lineItems", }, ], }, { type: "doc", - id: "references/js-client/classes/CollectionsResource", + id: "references/js-client/collections/classes/collections.CollectionsResource", label: "collections", }, { @@ -2817,80 +2857,105 @@ module.exports = { collapsed: true, link: { type: "doc", - id: "references/js-client/classes/CustomerResource", + id: "references/js-client/customers/classes/customers.CustomerResource", }, items: [ { type: "doc", - id: "references/js-client/classes/AddressesResource", + id: "references/js-client/addresses/classes/addresses.AddressesResource", label: "addresses", }, { type: "doc", - id: "references/js-client/classes/PaymentMethodsResource", + id: "references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource", label: "paymentMethods", }, ], }, { type: "doc", - id: "references/js-client/classes/GiftCardsResource", + id: "references/js-client/gift_cards/classes/gift_cards.GiftCardsResource", label: "giftCards", }, { type: "doc", - id: "references/js-client/classes/OrdersResource", - label: "orders", - }, - { - type: "doc", - id: "references/js-client/classes/OrderEditsResource", + id: "references/js-client/order_edits/classes/order_edits.OrderEditsResource", label: "orderEdits", }, { type: "doc", - id: "references/js-client/classes/PaymentMethodsResource", + id: "references/js-client/orders/classes/orders.OrdersResource", + label: "orders", + }, + { + type: "doc", + id: "references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource", + label: "paymentCollections", + }, + { + type: "doc", + id: "references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource", label: "paymentMethods", }, + { + type: "doc", + id: "references/js-client/product_categories/classes/product_categories.ProductCategoriesResource", + label: "productCategories", + }, + { + type: "doc", + id: "references/js-client/product_tags/classes/product_tags.ProductTagsResource", + label: "productTags", + }, + { + type: "doc", + id: "references/js-client/product_types/classes/product_types.ProductTypesResource", + label: "productTypes", + }, + { + type: "doc", + id: "references/js-client/product_types/classes/product_types.ProductTypesResource", + label: "productTypes", + }, { type: "category", label: "products", link: { type: "doc", - id: "references/js-client/classes/ProductsResource", + id: "references/js-client/products/classes/products.ProductsResource", }, collapsed: true, items: [ { type: "doc", - id: "references/js-client/classes/ProductVariantsResource", + id: "references/js-client/product_variants/classes/product_variants.ProductVariantsResource", label: "variants", }, ], }, { type: "doc", - id: "references/js-client/classes/RegionsResource", + id: "references/js-client/regions/classes/regions.RegionsResource", label: "regions", }, { type: "doc", - id: "references/js-client/classes/ReturnReasonsResource", + id: "references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource", label: "returnReasons", }, { type: "doc", - id: "references/js-client/classes/ReturnsResource", + id: "references/js-client/returns/classes/returns.ReturnsResource", label: "returns", }, { type: "doc", - id: "references/js-client/classes/ShippingOptionsResource", + id: "references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource", label: "shippingOptions", }, { type: "doc", - id: "references/js-client/classes/SwapsResource", + id: "references/js-client/swaps/classes/swaps.SwapsResource", label: "swaps", }, ],