From 3b28f46705e3417cd2bcc7869bd2dc3142ed2cab Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 8 Jul 2022 18:21:46 +0300 Subject: [PATCH] docs: added reference for JS Client (#1629) * added reference for JS Client * added reference for JS Client * added reference for JS Client --- .../typedoc-frontmatter-plugin/README.md | 35 + .../typedoc-frontmatter-plugin/dist/index.js | 49 + .../dist/index.js.map | 1 + .../typedoc-frontmatter-plugin/package.json | 32 + .../typedoc-frontmatter-plugin/src/index.ts | 53 + .../typedoc-frontmatter-plugin/tsconfig.json | 13 + .../typedoc-frontmatter-plugin/yarn.lock | 446 ++++++++ docs/content/js-client/overview.md | 79 ++ docs/content/references/js-client/.nojekyll | 1 + .../js-client/classes/AddressesResource.md | 77 ++ .../references/js-client/classes/Admin.md | 267 +++++ .../js-client/classes/AdminAuthResource.md | 75 ++ .../classes/AdminCollectionsResource.md | 133 +++ .../classes/AdminCustomerGroupsResource.md | 196 ++++ .../classes/AdminCustomersResource.md | 100 ++ .../classes/AdminDiscountsResource.md | 342 +++++++ .../classes/AdminDraftOrdersResource.md | 219 ++++ .../classes/AdminGiftCardsResource.md | 123 +++ .../js-client/classes/AdminInvitesResource.md | 111 ++ .../js-client/classes/AdminNotesResource.md | 113 +++ .../classes/AdminNotificationsResource.md | 50 + .../js-client/classes/AdminOrdersResource.md | 601 +++++++++++ .../classes/AdminPriceListResource.md | 223 ++++ .../classes/AdminProductTagsResource.md | 27 + .../classes/AdminProductTypesResource.md | 27 + .../classes/AdminProductsResource.md | 309 ++++++ .../js-client/classes/AdminRegionsResource.md | 366 +++++++ .../classes/AdminReturnReasonsResource.md | 132 +++ .../js-client/classes/AdminReturnsResource.md | 83 ++ .../classes/AdminShippingOptionsResource.md | 133 +++ .../classes/AdminShippingProfilesResource.md | 112 +++ .../js-client/classes/AdminStoresResource.md | 154 +++ .../js-client/classes/AdminSwapsResource.md | 49 + .../classes/AdminTaxRatesResource.md | 254 +++++ .../js-client/classes/AdminUploadsResource.md | 43 + .../js-client/classes/AdminUsersResource.md | 178 ++++ .../classes/AdminVariantsResource.md | 28 + .../js-client/classes/AuthResource.md | 76 ++ .../js-client/classes/CartsResource.md | 285 ++++++ .../js-client/classes/CollectionsResource.md | 53 + .../js-client/classes/CustomerResource.md | 165 +++ .../js-client/classes/GiftCardsResource.md | 30 + .../js-client/classes/LineItemsResource.md | 81 ++ .../js-client/classes/OrdersResource.md | 76 ++ .../classes/PaymentMethodsResource.md | 30 + .../classes/ProductVariantsResource.md | 53 + .../js-client/classes/ProductsResource.md | 86 ++ .../js-client/classes/RegionsResource.md | 52 + .../classes/ReturnReasonsResource.md | 52 + .../js-client/classes/ReturnsResource.md | 30 + .../classes/ShippingOptionsResource.md | 53 + .../js-client/classes/SwapsResource.md | 53 + .../classes/internal.AdditionalItem.md | 27 + .../js-client/classes/internal.Address.md | 219 ++++ .../classes/internal.AddressCreatePayload.md | 117 +++ .../classes/internal.AddressPayload.md | 123 +++ .../classes/internal.AdminCreateCondition.md | 93 ++ .../internal.AdminCreateUserRequest.md | 57 ++ ...leteCustomerGroupsGroupCustomerBatchReq.md | 17 + ...nal.AdminDeletePriceListPricesPricesReq.md | 17 + ...DeleteTaxRatesTaxRateProductTypesParams.md | 27 + ...minDeleteTaxRatesTaxRateProductTypesReq.md | 17 + ...dminDeleteTaxRatesTaxRateProductsParams.md | 27 + ...l.AdminDeleteTaxRatesTaxRateProductsReq.md | 17 + ...eteTaxRatesTaxRateShippingOptionsParams.md | 27 + ...DeleteTaxRatesTaxRateShippingOptionsReq.md | 17 + ...nal.AdminGetCollectionsPaginationParams.md | 33 + .../internal.AdminGetCollectionsParams.md | 101 ++ ...ernal.AdminGetCustomerGroupsGroupParams.md | 41 + .../internal.AdminGetCustomerGroupsParams.md | 123 +++ .../internal.AdminGetCustomersParams.md | 71 ++ ...countsDiscountConditionsConditionParams.md | 27 + ...nal.AdminGetDiscountsDiscountRuleParams.md | 27 + .../internal.AdminGetDiscountsParams.md | 77 ++ .../internal.AdminGetDraftOrdersParams.md | 37 + .../internal.AdminGetGiftCardsParams.md | 37 + .../classes/internal.AdminGetNotesParams.md | 37 + .../internal.AdminGetNotificationsParams.md | 97 ++ .../classes/internal.AdminGetOrdersParams.md | 263 +++++ ...ernal.AdminGetPriceListPaginationParams.md | 193 ++++ ...minGetPriceListsPriceListProductsParams.md | 209 ++++ ...nal.AdminGetProductTagsPaginationParams.md | 33 + .../internal.AdminGetProductTagsParams.md | 101 ++ ...al.AdminGetProductTypesPaginationParams.md | 33 + .../internal.AdminGetProductTypesParams.md | 101 ++ ...ternal.AdminGetProductsPaginationParams.md | 55 + .../internal.AdminGetProductsParams.md | 219 ++++ ...nternal.AdminGetRegionsPaginationParams.md | 33 + .../classes/internal.AdminGetRegionsParams.md | 71 ++ ...inGetRegionsRegionFulfillmentOptionsRes.md | 17 + .../classes/internal.AdminGetReturnsParams.md | 27 + .../internal.AdminGetShippingOptionsParams.md | 37 + .../classes/internal.AdminGetSwapsParams.md | 27 + .../internal.AdminGetTaxRatesParams.md | 87 ++ .../internal.AdminGetTaxRatesTaxRateParams.md | 27 + .../internal.AdminGetVariantsParams.md | 37 + .../internal.AdminListCustomerSelector.md | 33 + .../internal.AdminListOrdersSelector.md | 163 +++ .../classes/internal.AdminPostAuthReq.md | 27 + ...ernal.AdminPostCollectionsCollectionReq.md | 37 + .../internal.AdminPostCollectionsReq.md | 37 + ...ostCustomerGroupsGroupCustomersBatchReq.md | 17 + ...nternal.AdminPostCustomerGroupsGroupReq.md | 27 + .../internal.AdminPostCustomerGroupsReq.md | 27 + .../internal.AdminPostCustomersCustomerReq.md | 77 ++ .../classes/internal.AdminPostCustomersReq.md | 67 ++ ...al.AdminPostDiscountsDiscountConditions.md | 93 ++ ...ostDiscountsDiscountConditionsCondition.md | 83 ++ ...countsDiscountConditionsConditionParams.md | 27 + ...inPostDiscountsDiscountConditionsParams.md | 27 + ...minPostDiscountsDiscountDynamicCodesReq.md | 37 + .../internal.AdminPostDiscountsDiscountReq.md | 97 ++ ...internal.AdminPostDiscountsDiscountRule.md | 57 ++ .../classes/internal.AdminPostDiscountsReq.md | 107 ++ ...stDraftOrdersDraftOrderLineItemsItemReq.md | 47 + ...inPostDraftOrdersDraftOrderLineItemsReq.md | 57 ++ ...ernal.AdminPostDraftOrdersDraftOrderReq.md | 87 ++ .../internal.AdminPostGiftCardsGiftCardReq.md | 57 ++ .../classes/internal.AdminPostGiftCardsReq.md | 57 ++ ...nternal.AdminPostInvitesInviteAcceptReq.md | 27 + ...nal.AdminPostInvitesInviteAcceptUserReq.md | 37 + .../classes/internal.AdminPostInvitesReq.md | 27 + .../classes/internal.AdminPostNotesNoteReq.md | 17 + .../classes/internal.AdminPostNotesReq.md | 37 + ...nPostNotificationsNotificationResendReq.md | 17 + ...stOrdersOrderClaimsClaimFulfillmentsReq.md | 27 + ...rnal.AdminPostOrdersOrderClaimsClaimReq.md | 47 + ...nPostOrdersOrderClaimsClaimShipmentsReq.md | 27 + .../internal.AdminPostOrdersOrderClaimsReq.md | 97 ++ ...nal.AdminPostOrdersOrderFulfillmentsReq.md | 37 + ...internal.AdminPostOrdersOrderRefundsReq.md | 47 + .../internal.AdminPostOrdersOrderReq.md | 107 ++ ...internal.AdminPostOrdersOrderReturnsReq.md | 67 ++ ...nternal.AdminPostOrdersOrderShipmentReq.md | 37 + ....AdminPostOrdersOrderShippingMethodsReq.md | 37 + .../internal.AdminPostOrdersOrderSwapsReq.md | 67 ++ ...PostOrdersOrderSwapsSwapFulfillmentsReq.md | 27 + ...minPostOrdersOrderSwapsSwapShipmentsReq.md | 37 + .../classes/internal.AdminPostOrdersReq.md | 117 +++ ...ernal.AdminPostPriceListPricesPricesReq.md | 27 + ...dminPostPriceListsPriceListPriceListReq.md | 87 ++ ...nternal.AdminPostPriceListsPriceListReq.md | 87 ++ ...nal.AdminPostProductsProductMetadataReq.md | 27 + ...l.AdminPostProductsProductOptionsOption.md | 17 + ...rnal.AdminPostProductsProductOptionsReq.md | 17 + .../internal.AdminPostProductsProductReq.md | 217 ++++ ...nal.AdminPostProductsProductVariantsReq.md | 197 ++++ ...inPostProductsProductVariantsVariantReq.md | 197 ++++ .../classes/internal.AdminPostProductsReq.md | 237 +++++ ...rnal.AdminPostRegionsRegionCountriesReq.md | 17 + ...ostRegionsRegionFulfillmentProvidersReq.md | 17 + ...internal.AdminPostRegionsRegionMetadata.md | 27 + ...minPostRegionsRegionPaymentProvidersReq.md | 17 + .../internal.AdminPostRegionsRegionReq.md | 107 ++ .../classes/internal.AdminPostRegionsReq.md | 77 ++ ...nternal.AdminPostReturnReasonsReasonReq.md | 47 + .../internal.AdminPostReturnReasonsReq.md | 57 ++ ...ternal.AdminPostReturnsReturnReceiveReq.md | 27 + ...ernal.AdminPostShippingOptionsOptionReq.md | 57 ++ .../internal.AdminPostShippingOptionsReq.md | 117 +++ ...nal.AdminPostShippingProfilesProfileReq.md | 17 + .../internal.AdminPostShippingProfilesReq.md | 17 + .../classes/internal.AdminPostStoreReq.md | 67 ++ .../classes/internal.AdminPostTaxRatesReq.md | 77 ++ ...AdminPostTaxRatesTaxRateProductTypesReq.md | 17 + ...nal.AdminPostTaxRatesTaxRateProductsReq.md | 17 + .../internal.AdminPostTaxRatesTaxRateReq.md | 77 ++ ...inPostTaxRatesTaxRateShippingOptionsReq.md | 17 + .../internal.AdminPriceListPricesCreateReq.md | 67 ++ .../internal.AdminPriceListPricesUpdateReq.md | 77 ++ .../classes/internal.AdminRegionsRes.md | 17 + .../internal.AdminResetPasswordRequest.md | 37 + ...internal.AdminResetPasswordTokenRequest.md | 17 + .../internal.AdminUpdateDiscountRule.md | 57 ++ .../internal.AdminUpdateUserRequest.md | 57 ++ .../classes/internal.AdminUpsertCondition.md | 103 ++ .../internal.AdminUpsertConditionsReq.md | 69 ++ .../js-client/classes/internal.Axios.md | 294 ++++++ .../js-client/classes/internal.BaseEntity.md | 69 ++ .../js-client/classes/internal.Cart.md | 409 ++++++++ .../js-client/classes/internal.ClaimImage.md | 119 +++ .../js-client/classes/internal.ClaimItem.md | 199 ++++ .../js-client/classes/internal.ClaimOrder.md | 249 +++++ .../js-client/classes/internal.ClaimTag.md | 99 ++ .../js-client/classes/internal.Client.md | 186 ++++ .../js-client/classes/internal.Country.md | 87 ++ .../js-client/classes/internal.Currency.md | 47 + .../classes/internal.CustomShippingOption.md | 27 + .../js-client/classes/internal.Customer.md | 199 ++++ .../classes/internal.CustomerGroup.md | 119 +++ .../internal.CustomerGroupsBatchCustomer.md | 17 + .../internal.DateComparisonOperator.md | 47 + .../js-client/classes/internal.Discount.md | 219 ++++ .../classes/internal.DiscountCondition.md | 179 ++++ .../classes/internal.DiscountRule.md | 139 +++ .../js-client/classes/internal.DraftOrder.md | 175 ++++ .../internal.FilterableCustomerGroupProps.md | 63 ++ .../internal.FilterablePriceListProps.md | 113 +++ .../js-client/classes/internal.FindParams.md | 33 + .../js-client/classes/internal.Fulfillment.md | 235 +++++ .../classes/internal.FulfillmentItem.md | 57 ++ .../classes/internal.FulfillmentOption.md | 27 + .../classes/internal.FulfillmentProvider.md | 27 + .../js-client/classes/internal.GiftCard.md | 179 ++++ .../classes/internal.GiftCardTransaction.md | 87 ++ .../js-client/classes/internal.Group.md | 17 + .../classes/internal.IAdminPostUploadsFile.md | 27 + .../js-client/classes/internal.Image.md | 99 ++ .../js-client/classes/internal.Invite.md | 139 +++ .../js-client/classes/internal.Item.md | 27 + .../js-client/classes/internal.LineItem.md | 335 +++++++ .../classes/internal.LineItemAdjustment.md | 97 ++ .../classes/internal.LineItemTaxLine.md | 141 +++ .../js-client/classes/internal.MoneyAmount.md | 189 ++++ .../js-client/classes/internal.Note.md | 139 +++ .../classes/internal.Notification.md | 185 ++++ .../classes/internal.NotificationProvider.md | 27 + .../internal.NumericalComparisonOperator.md | 47 + .../classes/internal.OptionRequirement.md | 27 + .../js-client/classes/internal.Order.md | 525 ++++++++++ .../classes/internal.OrdersReturnItem.md | 47 + .../js-client/classes/internal.Payment.md | 225 +++++ .../classes/internal.PaymentMethod.md | 27 + .../classes/internal.PaymentProvider.md | 27 + .../classes/internal.PaymentSession.md | 135 +++ .../js-client/classes/internal.PriceList.md | 159 +++ .../classes/internal.PriceSelectionParams.md | 45 + .../js-client/classes/internal.Product.md | 359 +++++++ .../classes/internal.ProductCollection.md | 119 +++ .../classes/internal.ProductOption.md | 129 +++ .../classes/internal.ProductOptionReq.md | 17 + .../classes/internal.ProductOptionValue.md | 139 +++ .../js-client/classes/internal.ProductTag.md | 99 ++ .../classes/internal.ProductTagReq.md | 27 + .../js-client/classes/internal.ProductType.md | 99 ++ .../classes/internal.ProductTypeReq.md | 27 + .../classes/internal.ProductVariant.md | 299 ++++++ .../internal.ProductVariantOptionReq.md | 27 + .../internal.ProductVariantPricesCreateReq.md | 57 ++ .../internal.ProductVariantPricesUpdateReq.md | 67 ++ .../classes/internal.ProductVariantReq.md | 197 ++++ .../js-client/classes/internal.Refund.md | 135 +++ .../js-client/classes/internal.Region.md | 219 ++++ .../js-client/classes/internal.Return.md | 215 ++++ .../js-client/classes/internal.ReturnItem.md | 127 +++ .../classes/internal.ReturnReason.md | 149 +++ .../classes/internal.ReturnShipping.md | 27 + .../internal.ShippingAddressPayload.md | 17 + .../classes/internal.ShippingMethod.md | 177 ++++ .../classes/internal.ShippingMethodTaxLine.md | 141 +++ .../classes/internal.ShippingOption.md | 219 ++++ .../internal.ShippingOptionRequirement.md | 77 ++ .../classes/internal.ShippingProfile.md | 129 +++ .../classes/internal.SoftDeletableEntity.md | 127 +++ .../js-client/classes/internal.Store.md | 145 +++ .../internal.StoreGetCollectionsParams.md | 47 + ...l.StoreGetCustomersCustomerOrdersParams.md | 47 + .../classes/internal.StoreGetOrdersParams.md | 37 + ...ternal.StoreGetProductsPaginationParams.md | 97 ++ .../internal.StoreGetProductsParams.md | 221 ++++ .../internal.StoreGetShippingOptionsParams.md | 37 + .../internal.StoreGetVariantsParams.md | 125 +++ .../classes/internal.StorePostAuthReq.md | 27 + .../classes/internal.StorePostCartReq.md | 47 + ...rnal.StorePostCartsCartLineItemsItemReq.md | 17 + ...internal.StorePostCartsCartLineItemsReq.md | 37 + ...nal.StorePostCartsCartPaymentSessionReq.md | 17 + ...orePostCartsCartPaymentSessionUpdateReq.md | 17 + .../classes/internal.StorePostCartsCartReq.md | 97 ++ ...nal.StorePostCartsCartShippingMethodReq.md | 27 + ...ostCustomersCustomerAddressesAddressReq.md | 167 +++ ....StorePostCustomersCustomerAddressesReq.md | 17 + ...rePostCustomersCustomerPasswordTokenReq.md | 17 + .../internal.StorePostCustomersCustomerReq.md | 77 ++ .../classes/internal.StorePostCustomersReq.md | 57 ++ .../classes/internal.StorePostReturnsReq.md | 37 + .../classes/internal.StorePostSearchReq.md | 47 + .../classes/internal.StorePostSwapsReq.md | 47 + .../internal.StringComparisonOperator.md | 47 + .../js-client/classes/internal.Swap.md | 279 ++++++ .../js-client/classes/internal.TaxLine.md | 99 ++ .../js-client/classes/internal.TaxProvider.md | 27 + .../js-client/classes/internal.TaxRate.md | 185 ++++ .../classes/internal.TrackingLink.md | 139 +++ .../js-client/classes/internal.User.md | 149 +++ .../enums/internal.AllocationType.md | 27 + .../js-client/enums/internal.CartType.md | 57 ++ .../enums/internal.ClaimFulfillmentStatus.md | 97 ++ .../enums/internal.ClaimPaymentStatus.md | 37 + .../js-client/enums/internal.ClaimReason.md | 47 + .../js-client/enums/internal.ClaimType.md | 27 + .../internal.DiscountConditionOperator.md | 27 + .../enums/internal.DiscountConditionType.md | 57 ++ .../enums/internal.DiscountRuleType.md | 37 + .../enums/internal.DraftOrderStatus.md | 27 + .../enums/internal.FulfillmentStatus.md | 97 ++ .../js-client/enums/internal.OrderStatus.md | 57 ++ .../js-client/enums/internal.PaymentStatus.md | 77 ++ .../enums/internal.PriceListStatus.md | 27 + .../js-client/enums/internal.PriceListType.md | 27 + .../js-client/enums/internal.ProductStatus.md | 47 + .../enums/internal.RequirementType.md | 27 + .../js-client/enums/internal.ReturnStatus.md | 47 + .../enums/internal.ShippingOptionPriceType.md | 27 + .../enums/internal.ShippingProfileType.md | 37 + .../js-client/enums/internal.Status.md | 47 + .../enums/internal.SwapFulfillmentStatus.md | 57 ++ .../enums/internal.SwapPaymentStatus.md | 97 ++ .../js-client/enums/internal.UserRoles.md | 37 + docs/content/references/js-client/index.md | 92 ++ .../interfaces/internal.AbortSignal.md | 21 + .../interfaces/internal.AxiosAdapter.md | 27 + .../internal.AxiosBasicCredentials.md | 27 + .../interfaces/internal.AxiosDefaults.md | 507 ++++++++++ .../interfaces/internal.AxiosError.md | 126 +++ .../interfaces/internal.AxiosInstance.md | 377 +++++++ .../internal.AxiosInterceptorManager.md | 60 ++ .../interfaces/internal.AxiosPromise.md | 132 +++ .../interfaces/internal.AxiosProxyConfig.md | 54 + .../interfaces/internal.AxiosRequestConfig.md | 373 +++++++ .../internal.AxiosRequestTransformer.md | 28 + .../interfaces/internal.AxiosResponse.md | 74 ++ .../internal.AxiosResponseTransformer.md | 28 + .../js-client/interfaces/internal.CallSite.md | 222 ++++ .../js-client/interfaces/internal.Cancel.md | 17 + .../interfaces/internal.CancelToken.md | 41 + .../js-client/interfaces/internal.Config.md | 37 + .../js-client/interfaces/internal.Date.md | 948 ++++++++++++++++++ .../interfaces/internal.DateConstructor.md | 95 ++ .../internal.DateTimeFormatOptions.md | 197 ++++ .../js-client/interfaces/internal.Error.md | 37 + .../interfaces/internal.ErrorConstructor.md | 99 ++ .../js-client/interfaces/internal.Function.md | 176 ++++ .../internal.FunctionConstructor.md | 37 + .../interfaces/internal.HTTPResponse.md | 57 ++ .../interfaces/internal.HeadersDefaults.md | 117 +++ .../js-client/interfaces/internal.Iterable.md | 27 + .../js-client/interfaces/internal.Iterator.md | 75 ++ .../internal.IteratorReturnResult.md | 33 + .../internal.IteratorYieldResult.md | 33 + .../js-client/interfaces/internal.Promise.md | 112 +++ .../interfaces/internal.PromiseConstructor.md | 277 +++++ .../internal.PromiseFulfilledResult.md | 33 + .../interfaces/internal.PromiseLike.md | 45 + .../internal.PromiseRejectedResult.md | 27 + .../interfaces/internal.RequestOptions.md | 27 + .../interfaces/internal.RetryConfig.md | 187 ++++ .../internal.TransitionalOptions.md | 37 + .../references/js-client/modules/internal.md | 25 + package.json | 5 + packages/medusa-js/README.md | 4 +- packages/medusa-js/package.json | 3 +- typedoc.js-client.js | 27 + www/docs/docusaurus.config.js | 5 + www/docs/sidebars.js | 258 +++++ www/docs/src/css/custom.css | 3 +- yarn.lock | 19 + 357 files changed, 32911 insertions(+), 3 deletions(-) create mode 100644 docs-util/typedoc-plugins/typedoc-frontmatter-plugin/README.md create mode 100644 docs-util/typedoc-plugins/typedoc-frontmatter-plugin/dist/index.js create mode 100644 docs-util/typedoc-plugins/typedoc-frontmatter-plugin/dist/index.js.map create mode 100644 docs-util/typedoc-plugins/typedoc-frontmatter-plugin/package.json create mode 100644 docs-util/typedoc-plugins/typedoc-frontmatter-plugin/src/index.ts create mode 100644 docs-util/typedoc-plugins/typedoc-frontmatter-plugin/tsconfig.json create mode 100644 docs-util/typedoc-plugins/typedoc-frontmatter-plugin/yarn.lock create mode 100644 docs/content/js-client/overview.md create mode 100644 docs/content/references/js-client/.nojekyll create mode 100644 docs/content/references/js-client/classes/AddressesResource.md create mode 100644 docs/content/references/js-client/classes/Admin.md create mode 100644 docs/content/references/js-client/classes/AdminAuthResource.md create mode 100644 docs/content/references/js-client/classes/AdminCollectionsResource.md create mode 100644 docs/content/references/js-client/classes/AdminCustomerGroupsResource.md create mode 100644 docs/content/references/js-client/classes/AdminCustomersResource.md create mode 100644 docs/content/references/js-client/classes/AdminDiscountsResource.md create mode 100644 docs/content/references/js-client/classes/AdminDraftOrdersResource.md create mode 100644 docs/content/references/js-client/classes/AdminGiftCardsResource.md create mode 100644 docs/content/references/js-client/classes/AdminInvitesResource.md create mode 100644 docs/content/references/js-client/classes/AdminNotesResource.md create mode 100644 docs/content/references/js-client/classes/AdminNotificationsResource.md create mode 100644 docs/content/references/js-client/classes/AdminOrdersResource.md create mode 100644 docs/content/references/js-client/classes/AdminPriceListResource.md create mode 100644 docs/content/references/js-client/classes/AdminProductTagsResource.md create mode 100644 docs/content/references/js-client/classes/AdminProductTypesResource.md create mode 100644 docs/content/references/js-client/classes/AdminProductsResource.md create mode 100644 docs/content/references/js-client/classes/AdminRegionsResource.md create mode 100644 docs/content/references/js-client/classes/AdminReturnReasonsResource.md create mode 100644 docs/content/references/js-client/classes/AdminReturnsResource.md create mode 100644 docs/content/references/js-client/classes/AdminShippingOptionsResource.md create mode 100644 docs/content/references/js-client/classes/AdminShippingProfilesResource.md create mode 100644 docs/content/references/js-client/classes/AdminStoresResource.md create mode 100644 docs/content/references/js-client/classes/AdminSwapsResource.md create mode 100644 docs/content/references/js-client/classes/AdminTaxRatesResource.md create mode 100644 docs/content/references/js-client/classes/AdminUploadsResource.md create mode 100644 docs/content/references/js-client/classes/AdminUsersResource.md create mode 100644 docs/content/references/js-client/classes/AdminVariantsResource.md create mode 100644 docs/content/references/js-client/classes/AuthResource.md create mode 100644 docs/content/references/js-client/classes/CartsResource.md create mode 100644 docs/content/references/js-client/classes/CollectionsResource.md create mode 100644 docs/content/references/js-client/classes/CustomerResource.md create mode 100644 docs/content/references/js-client/classes/GiftCardsResource.md create mode 100644 docs/content/references/js-client/classes/LineItemsResource.md create mode 100644 docs/content/references/js-client/classes/OrdersResource.md create mode 100644 docs/content/references/js-client/classes/PaymentMethodsResource.md create mode 100644 docs/content/references/js-client/classes/ProductVariantsResource.md create mode 100644 docs/content/references/js-client/classes/ProductsResource.md create mode 100644 docs/content/references/js-client/classes/RegionsResource.md create mode 100644 docs/content/references/js-client/classes/ReturnReasonsResource.md create mode 100644 docs/content/references/js-client/classes/ReturnsResource.md create mode 100644 docs/content/references/js-client/classes/ShippingOptionsResource.md create mode 100644 docs/content/references/js-client/classes/SwapsResource.md create mode 100644 docs/content/references/js-client/classes/internal.AdditionalItem.md create mode 100644 docs/content/references/js-client/classes/internal.Address.md create mode 100644 docs/content/references/js-client/classes/internal.AddressCreatePayload.md create mode 100644 docs/content/references/js-client/classes/internal.AddressPayload.md create mode 100644 docs/content/references/js-client/classes/internal.AdminCreateCondition.md create mode 100644 docs/content/references/js-client/classes/internal.AdminCreateUserRequest.md create mode 100644 docs/content/references/js-client/classes/internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminDeletePriceListPricesPricesReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetCollectionsPaginationParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetCollectionsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsGroupParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetCustomersParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountConditionsConditionParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountRuleParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetDiscountsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetDraftOrdersParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetGiftCardsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetNotesParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetNotificationsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetOrdersParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetPriceListPaginationParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetPriceListsPriceListProductsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetProductTagsPaginationParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetProductTagsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetProductTypesPaginationParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetProductTypesParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetProductsPaginationParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetProductsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetRegionsPaginationParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetRegionsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetRegionsRegionFulfillmentOptionsRes.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetReturnsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetShippingOptionsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetSwapsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetTaxRatesParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetTaxRatesTaxRateParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminGetVariantsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminListCustomerSelector.md create mode 100644 docs/content/references/js-client/classes/internal.AdminListOrdersSelector.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostAuthReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostCollectionsCollectionReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostCollectionsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupCustomersBatchReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostCustomersCustomerReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostCustomersReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditions.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsCondition.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsConditionParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsParams.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountDynamicCodesReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountRule.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostDiscountsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostGiftCardsGiftCardReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostGiftCardsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptUserReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostInvitesReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostNotesNoteReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostNotesReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostNotificationsNotificationResendReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersOrderFulfillmentsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersOrderRefundsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReturnsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShipmentReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShippingMethodsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostOrdersReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostPriceListPricesPricesReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListPriceListReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostProductsProductMetadataReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsOption.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostProductsProductReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsVariantReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostProductsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostRegionsRegionCountriesReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostRegionsRegionFulfillmentProvidersReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostRegionsRegionMetadata.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostRegionsRegionPaymentProvidersReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostRegionsRegionReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostRegionsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReasonReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostReturnsReturnReceiveReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostShippingOptionsOptionReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostShippingOptionsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostShippingProfilesProfileReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostShippingProfilesReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostStoreReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostTaxRatesReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductTypesReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPriceListPricesCreateReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminPriceListPricesUpdateReq.md create mode 100644 docs/content/references/js-client/classes/internal.AdminRegionsRes.md create mode 100644 docs/content/references/js-client/classes/internal.AdminResetPasswordRequest.md create mode 100644 docs/content/references/js-client/classes/internal.AdminResetPasswordTokenRequest.md create mode 100644 docs/content/references/js-client/classes/internal.AdminUpdateDiscountRule.md create mode 100644 docs/content/references/js-client/classes/internal.AdminUpdateUserRequest.md create mode 100644 docs/content/references/js-client/classes/internal.AdminUpsertCondition.md create mode 100644 docs/content/references/js-client/classes/internal.AdminUpsertConditionsReq.md create mode 100644 docs/content/references/js-client/classes/internal.Axios.md create mode 100644 docs/content/references/js-client/classes/internal.BaseEntity.md create mode 100644 docs/content/references/js-client/classes/internal.Cart.md create mode 100644 docs/content/references/js-client/classes/internal.ClaimImage.md create mode 100644 docs/content/references/js-client/classes/internal.ClaimItem.md create mode 100644 docs/content/references/js-client/classes/internal.ClaimOrder.md create mode 100644 docs/content/references/js-client/classes/internal.ClaimTag.md create mode 100644 docs/content/references/js-client/classes/internal.Client.md create mode 100644 docs/content/references/js-client/classes/internal.Country.md create mode 100644 docs/content/references/js-client/classes/internal.Currency.md create mode 100644 docs/content/references/js-client/classes/internal.CustomShippingOption.md create mode 100644 docs/content/references/js-client/classes/internal.Customer.md create mode 100644 docs/content/references/js-client/classes/internal.CustomerGroup.md create mode 100644 docs/content/references/js-client/classes/internal.CustomerGroupsBatchCustomer.md create mode 100644 docs/content/references/js-client/classes/internal.DateComparisonOperator.md create mode 100644 docs/content/references/js-client/classes/internal.Discount.md create mode 100644 docs/content/references/js-client/classes/internal.DiscountCondition.md create mode 100644 docs/content/references/js-client/classes/internal.DiscountRule.md create mode 100644 docs/content/references/js-client/classes/internal.DraftOrder.md create mode 100644 docs/content/references/js-client/classes/internal.FilterableCustomerGroupProps.md create mode 100644 docs/content/references/js-client/classes/internal.FilterablePriceListProps.md create mode 100644 docs/content/references/js-client/classes/internal.FindParams.md create mode 100644 docs/content/references/js-client/classes/internal.Fulfillment.md create mode 100644 docs/content/references/js-client/classes/internal.FulfillmentItem.md create mode 100644 docs/content/references/js-client/classes/internal.FulfillmentOption.md create mode 100644 docs/content/references/js-client/classes/internal.FulfillmentProvider.md create mode 100644 docs/content/references/js-client/classes/internal.GiftCard.md create mode 100644 docs/content/references/js-client/classes/internal.GiftCardTransaction.md create mode 100644 docs/content/references/js-client/classes/internal.Group.md create mode 100644 docs/content/references/js-client/classes/internal.IAdminPostUploadsFile.md create mode 100644 docs/content/references/js-client/classes/internal.Image.md create mode 100644 docs/content/references/js-client/classes/internal.Invite.md create mode 100644 docs/content/references/js-client/classes/internal.Item.md create mode 100644 docs/content/references/js-client/classes/internal.LineItem.md create mode 100644 docs/content/references/js-client/classes/internal.LineItemAdjustment.md create mode 100644 docs/content/references/js-client/classes/internal.LineItemTaxLine.md create mode 100644 docs/content/references/js-client/classes/internal.MoneyAmount.md create mode 100644 docs/content/references/js-client/classes/internal.Note.md create mode 100644 docs/content/references/js-client/classes/internal.Notification.md create mode 100644 docs/content/references/js-client/classes/internal.NotificationProvider.md create mode 100644 docs/content/references/js-client/classes/internal.NumericalComparisonOperator.md create mode 100644 docs/content/references/js-client/classes/internal.OptionRequirement.md create mode 100644 docs/content/references/js-client/classes/internal.Order.md create mode 100644 docs/content/references/js-client/classes/internal.OrdersReturnItem.md create mode 100644 docs/content/references/js-client/classes/internal.Payment.md create mode 100644 docs/content/references/js-client/classes/internal.PaymentMethod.md create mode 100644 docs/content/references/js-client/classes/internal.PaymentProvider.md create mode 100644 docs/content/references/js-client/classes/internal.PaymentSession.md create mode 100644 docs/content/references/js-client/classes/internal.PriceList.md create mode 100644 docs/content/references/js-client/classes/internal.PriceSelectionParams.md create mode 100644 docs/content/references/js-client/classes/internal.Product.md create mode 100644 docs/content/references/js-client/classes/internal.ProductCollection.md create mode 100644 docs/content/references/js-client/classes/internal.ProductOption.md create mode 100644 docs/content/references/js-client/classes/internal.ProductOptionReq.md create mode 100644 docs/content/references/js-client/classes/internal.ProductOptionValue.md create mode 100644 docs/content/references/js-client/classes/internal.ProductTag.md create mode 100644 docs/content/references/js-client/classes/internal.ProductTagReq.md create mode 100644 docs/content/references/js-client/classes/internal.ProductType.md create mode 100644 docs/content/references/js-client/classes/internal.ProductTypeReq.md create mode 100644 docs/content/references/js-client/classes/internal.ProductVariant.md create mode 100644 docs/content/references/js-client/classes/internal.ProductVariantOptionReq.md create mode 100644 docs/content/references/js-client/classes/internal.ProductVariantPricesCreateReq.md create mode 100644 docs/content/references/js-client/classes/internal.ProductVariantPricesUpdateReq.md create mode 100644 docs/content/references/js-client/classes/internal.ProductVariantReq.md create mode 100644 docs/content/references/js-client/classes/internal.Refund.md create mode 100644 docs/content/references/js-client/classes/internal.Region.md create mode 100644 docs/content/references/js-client/classes/internal.Return.md create mode 100644 docs/content/references/js-client/classes/internal.ReturnItem.md create mode 100644 docs/content/references/js-client/classes/internal.ReturnReason.md create mode 100644 docs/content/references/js-client/classes/internal.ReturnShipping.md create mode 100644 docs/content/references/js-client/classes/internal.ShippingAddressPayload.md create mode 100644 docs/content/references/js-client/classes/internal.ShippingMethod.md create mode 100644 docs/content/references/js-client/classes/internal.ShippingMethodTaxLine.md create mode 100644 docs/content/references/js-client/classes/internal.ShippingOption.md create mode 100644 docs/content/references/js-client/classes/internal.ShippingOptionRequirement.md create mode 100644 docs/content/references/js-client/classes/internal.ShippingProfile.md create mode 100644 docs/content/references/js-client/classes/internal.SoftDeletableEntity.md create mode 100644 docs/content/references/js-client/classes/internal.Store.md create mode 100644 docs/content/references/js-client/classes/internal.StoreGetCollectionsParams.md create mode 100644 docs/content/references/js-client/classes/internal.StoreGetCustomersCustomerOrdersParams.md create mode 100644 docs/content/references/js-client/classes/internal.StoreGetOrdersParams.md create mode 100644 docs/content/references/js-client/classes/internal.StoreGetProductsPaginationParams.md create mode 100644 docs/content/references/js-client/classes/internal.StoreGetProductsParams.md create mode 100644 docs/content/references/js-client/classes/internal.StoreGetShippingOptionsParams.md create mode 100644 docs/content/references/js-client/classes/internal.StoreGetVariantsParams.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostAuthReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostCartReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsItemReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionUpdateReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostCartsCartReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostCartsCartShippingMethodReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostCustomersCustomerPasswordTokenReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostCustomersCustomerReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostCustomersReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostReturnsReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostSearchReq.md create mode 100644 docs/content/references/js-client/classes/internal.StorePostSwapsReq.md create mode 100644 docs/content/references/js-client/classes/internal.StringComparisonOperator.md create mode 100644 docs/content/references/js-client/classes/internal.Swap.md create mode 100644 docs/content/references/js-client/classes/internal.TaxLine.md create mode 100644 docs/content/references/js-client/classes/internal.TaxProvider.md create mode 100644 docs/content/references/js-client/classes/internal.TaxRate.md create mode 100644 docs/content/references/js-client/classes/internal.TrackingLink.md create mode 100644 docs/content/references/js-client/classes/internal.User.md create mode 100644 docs/content/references/js-client/enums/internal.AllocationType.md create mode 100644 docs/content/references/js-client/enums/internal.CartType.md create mode 100644 docs/content/references/js-client/enums/internal.ClaimFulfillmentStatus.md create mode 100644 docs/content/references/js-client/enums/internal.ClaimPaymentStatus.md create mode 100644 docs/content/references/js-client/enums/internal.ClaimReason.md create mode 100644 docs/content/references/js-client/enums/internal.ClaimType.md create mode 100644 docs/content/references/js-client/enums/internal.DiscountConditionOperator.md create mode 100644 docs/content/references/js-client/enums/internal.DiscountConditionType.md create mode 100644 docs/content/references/js-client/enums/internal.DiscountRuleType.md create mode 100644 docs/content/references/js-client/enums/internal.DraftOrderStatus.md create mode 100644 docs/content/references/js-client/enums/internal.FulfillmentStatus.md create mode 100644 docs/content/references/js-client/enums/internal.OrderStatus.md create mode 100644 docs/content/references/js-client/enums/internal.PaymentStatus.md create mode 100644 docs/content/references/js-client/enums/internal.PriceListStatus.md create mode 100644 docs/content/references/js-client/enums/internal.PriceListType.md create mode 100644 docs/content/references/js-client/enums/internal.ProductStatus.md create mode 100644 docs/content/references/js-client/enums/internal.RequirementType.md create mode 100644 docs/content/references/js-client/enums/internal.ReturnStatus.md create mode 100644 docs/content/references/js-client/enums/internal.ShippingOptionPriceType.md create mode 100644 docs/content/references/js-client/enums/internal.ShippingProfileType.md create mode 100644 docs/content/references/js-client/enums/internal.Status.md create mode 100644 docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md create mode 100644 docs/content/references/js-client/enums/internal.SwapPaymentStatus.md create mode 100644 docs/content/references/js-client/enums/internal.UserRoles.md create mode 100644 docs/content/references/js-client/index.md create mode 100644 docs/content/references/js-client/interfaces/internal.AbortSignal.md create mode 100644 docs/content/references/js-client/interfaces/internal.AxiosAdapter.md create mode 100644 docs/content/references/js-client/interfaces/internal.AxiosBasicCredentials.md create mode 100644 docs/content/references/js-client/interfaces/internal.AxiosDefaults.md create mode 100644 docs/content/references/js-client/interfaces/internal.AxiosError.md create mode 100644 docs/content/references/js-client/interfaces/internal.AxiosInstance.md create mode 100644 docs/content/references/js-client/interfaces/internal.AxiosInterceptorManager.md create mode 100644 docs/content/references/js-client/interfaces/internal.AxiosPromise.md create mode 100644 docs/content/references/js-client/interfaces/internal.AxiosProxyConfig.md create mode 100644 docs/content/references/js-client/interfaces/internal.AxiosRequestConfig.md create mode 100644 docs/content/references/js-client/interfaces/internal.AxiosRequestTransformer.md create mode 100644 docs/content/references/js-client/interfaces/internal.AxiosResponse.md create mode 100644 docs/content/references/js-client/interfaces/internal.AxiosResponseTransformer.md create mode 100644 docs/content/references/js-client/interfaces/internal.CallSite.md create mode 100644 docs/content/references/js-client/interfaces/internal.Cancel.md create mode 100644 docs/content/references/js-client/interfaces/internal.CancelToken.md create mode 100644 docs/content/references/js-client/interfaces/internal.Config.md create mode 100644 docs/content/references/js-client/interfaces/internal.Date.md create mode 100644 docs/content/references/js-client/interfaces/internal.DateConstructor.md create mode 100644 docs/content/references/js-client/interfaces/internal.DateTimeFormatOptions.md create mode 100644 docs/content/references/js-client/interfaces/internal.Error.md create mode 100644 docs/content/references/js-client/interfaces/internal.ErrorConstructor.md create mode 100644 docs/content/references/js-client/interfaces/internal.Function.md create mode 100644 docs/content/references/js-client/interfaces/internal.FunctionConstructor.md create mode 100644 docs/content/references/js-client/interfaces/internal.HTTPResponse.md create mode 100644 docs/content/references/js-client/interfaces/internal.HeadersDefaults.md create mode 100644 docs/content/references/js-client/interfaces/internal.Iterable.md create mode 100644 docs/content/references/js-client/interfaces/internal.Iterator.md create mode 100644 docs/content/references/js-client/interfaces/internal.IteratorReturnResult.md create mode 100644 docs/content/references/js-client/interfaces/internal.IteratorYieldResult.md create mode 100644 docs/content/references/js-client/interfaces/internal.Promise.md create mode 100644 docs/content/references/js-client/interfaces/internal.PromiseConstructor.md create mode 100644 docs/content/references/js-client/interfaces/internal.PromiseFulfilledResult.md create mode 100644 docs/content/references/js-client/interfaces/internal.PromiseLike.md create mode 100644 docs/content/references/js-client/interfaces/internal.PromiseRejectedResult.md create mode 100644 docs/content/references/js-client/interfaces/internal.RequestOptions.md create mode 100644 docs/content/references/js-client/interfaces/internal.RetryConfig.md create mode 100644 docs/content/references/js-client/interfaces/internal.TransitionalOptions.md create mode 100644 docs/content/references/js-client/modules/internal.md create mode 100644 typedoc.js-client.js diff --git a/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/README.md b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/README.md new file mode 100644 index 0000000000..db7fa1e8db --- /dev/null +++ b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/README.md @@ -0,0 +1,35 @@ +# typedoc-frontmatter-plugin + +A Typedoc plugin that allows inserting frontmatter key-value pairs at the top of the exported Markdown files. + +## Configurations + +The following options are optional and can be used to customize the configurations of the plugin. + +### frontmatterData + +`frontmatterData` is an object of key-value pairs. If none provided, no frontmatter variables will be added to the Markdown files. + +An example of passing it in a JavaScript configuration file: + +```js +frontmatterData: { + displayed_sidebar: "jsClientSidebar", +}, +``` + +If passing the option in the command line the value should be a JSON object. + +### pagesPattern + +`pagesPattern` is a string that contains a regular expression. This allows you to limit the pages the frontmatter variables should be added to. + +By default, the frontmatter variables will be added to all files. + +An example of passing it in a JavaScript configuration file: + +```js +frontmatterData: { + pagesPattern: "internal\\.", +}, +``` diff --git a/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/dist/index.js b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/dist/index.js new file mode 100644 index 0000000000..10bbf68223 --- /dev/null +++ b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/dist/index.js @@ -0,0 +1,49 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.load = void 0; +const typedoc_1 = require("typedoc"); +function load(app) { + app.options.addDeclaration({ + name: "frontmatterData", + help: "An object of key-value pairs to be added to frontmatter", + type: typedoc_1.ParameterType.Mixed, + defaultValue: {}, + validate: (value) => { + if (typeof value === 'string') { + //decode it with JSON to check if it's an object + value = JSON.parse(value); + } + if (!(typeof value === 'object' && + !Array.isArray(value) && + value !== null)) { + throw new Error("Value should be an object"); + } + } + }); + app.options.addDeclaration({ + name: "pagesPattern", + help: "A string of pages pattern. The pattern will be tested using RegExp to determine whether the frontmatterData will be added or not.", + type: typedoc_1.ParameterType.String, + defaultValue: "" + }); + app.renderer.on(typedoc_1.PageEvent.END, (page) => { + const patternStr = app.options.getValue("pagesPattern"); + const pattern = new RegExp(patternStr); + let frontmatterData = app.options.getValue("frontmatterData"); + if (typeof frontmatterData === 'string') { + frontmatterData = JSON.parse(frontmatterData); + } + const frontmatterDataEntries = Object.entries(frontmatterData); + if (!frontmatterDataEntries.length || !pattern.test(page.filename)) { + return; + } + let frontmatterStr = `---\n`; + for (const [key, value] of frontmatterDataEntries) { + frontmatterStr += `${key}: ${value}\n`; + } + frontmatterStr += `---\n\n`; + page.contents = frontmatterStr + page.contents; + }); +} +exports.load = load; +//# sourceMappingURL=index.js.map \ No newline at end of file diff --git a/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/dist/index.js.map b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/dist/index.js.map new file mode 100644 index 0000000000..b99a5fae84 --- /dev/null +++ b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/dist/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qCAAgE;AAEhE,SAAgB,IAAI,CAAC,GAAgB;IACjC,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC;QACvB,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,yDAAyD;QAC/D,IAAI,EAAE,uBAAa,CAAC,KAAK;QACzB,YAAY,EAAE,EAAE;QAChB,QAAQ,EAAE,CAAC,KAAU,EAAE,EAAE;YACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBAC7B,gDAAgD;gBAChD,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aAC3B;YAED,IAAI,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ;gBAC/B,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBACrB,KAAK,KAAK,IAAI,CAAC,EAAE;gBACf,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;aAC7C;QACH,CAAC;KACJ,CAAC,CAAC;IAEH,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC;QACzB,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,mIAAmI;QACzI,IAAI,EAAE,uBAAa,CAAC,MAAM;QAC1B,YAAY,EAAE,EAAE;KACjB,CAAC,CAAA;IAEF,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,mBAAS,CAAC,GAAG,EAAE,CAAC,IAAe,EAAE,EAAE;QAC/C,MAAM,UAAU,GAAiB,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;QACrE,MAAM,OAAO,GAAW,IAAI,MAAM,CAAC,UAAU,CAAC,CAAA;QAC9C,IAAI,eAAe,GAAiB,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAA;QAC3E,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE;YACvC,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;SAC/C;QACD,MAAM,sBAAsB,GAAG,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;QAE9D,IAAI,CAAC,sBAAsB,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAClE,OAAO;SACR;QAED,IAAI,cAAc,GAAG,OAAO,CAAA;QAE5B,KAAI,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,sBAAsB,EAAE;YAChD,cAAc,IAAI,GAAG,GAAG,KAAK,KAAK,IAAI,CAAA;SACvC;QAED,cAAc,IAAI,SAAS,CAAA;QAE3B,IAAI,CAAC,QAAQ,GAAG,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAA;IAClD,CAAC,CAAC,CAAC;AACP,CAAC;AAlDD,oBAkDC"} \ No newline at end of file diff --git a/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/package.json b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/package.json new file mode 100644 index 0000000000..1eb19affdd --- /dev/null +++ b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/package.json @@ -0,0 +1,32 @@ +{ + "name": "typedoc-frontmatter-plugin", + "version": "1.0.0", + "description": "Plugin to add frontmatter key-values at the top of pages", + "main": "./dist/index.js", + "exports": "./dist/index.js", + "files": [ + "dist" + ], + "author": "Shahed Nasser", + "license": "MIT", + "scripts": { + "build": "tsc" + }, + "peerDependencies": { + "typedoc": "0.22.x" + }, + "devDependencies": { + "@types/node": "^16.11.10", + "typedoc": "^0.22.10", + "@typescript-eslint/eslint-plugin": "5.6.0", + "@typescript-eslint/parser": "5.6.0", + "typescript": "4.5.2" + }, + "keywords": [ + "typedocplugin", + "packages", + "monorepo", + "lerna", + "typedoc" + ] +} diff --git a/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/src/index.ts b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/src/index.ts new file mode 100644 index 0000000000..9edf89e24f --- /dev/null +++ b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/src/index.ts @@ -0,0 +1,53 @@ +import { Application, PageEvent, ParameterType } from "typedoc"; + +export function load(app: Application) { + app.options.addDeclaration({ + name: "frontmatterData", + help: "An object of key-value pairs to be added to frontmatter", + type: ParameterType.Mixed, // The default + defaultValue: {}, + validate: (value: any) => { + if (typeof value === 'string') { + //decode it with JSON to check if it's an object + value = JSON.parse(value); + } + + if (!(typeof value === 'object' && + !Array.isArray(value) && + value !== null)) { + throw new Error("Value should be an object") + } + } + }); + + app.options.addDeclaration({ + name: "pagesPattern", + help: "A string of pages pattern. The pattern will be tested using RegExp to determine whether the frontmatterData will be added or not.", + type: ParameterType.String, + defaultValue: "" + }) + + app.renderer.on(PageEvent.END, (page: PageEvent) => { + const patternStr: String | any = app.options.getValue("pagesPattern") + const pattern: RegExp = new RegExp(patternStr) + let frontmatterData: Object | any = app.options.getValue("frontmatterData") + if (typeof frontmatterData === 'string') { + frontmatterData = JSON.parse(frontmatterData); + } + const frontmatterDataEntries = Object.entries(frontmatterData) + + if (!frontmatterDataEntries.length || !pattern.test(page.filename)) { + return; + } + + let frontmatterStr = `---\n` + + for(const [key, value] of frontmatterDataEntries) { + frontmatterStr += `${key}: ${value}\n` + } + + frontmatterStr += `---\n\n` + + page.contents = frontmatterStr + page.contents + }); +} \ No newline at end of file diff --git a/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/tsconfig.json b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/tsconfig.json new file mode 100644 index 0000000000..55f28c3714 --- /dev/null +++ b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/tsconfig.json @@ -0,0 +1,13 @@ +{ + "compilerOptions": { + "target": "es2018", + "module": "commonjs", + "outDir": "./dist", + "isolatedModules": true, + "esModuleInterop": true, + "forceConsistentCasingInFileNames": true, + "strict": true, + "sourceMap": true + }, + "include": ["src"] +} \ No newline at end of file diff --git a/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/yarn.lock b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/yarn.lock new file mode 100644 index 0000000000..ba670dcc91 --- /dev/null +++ b/docs-util/typedoc-plugins/typedoc-frontmatter-plugin/yarn.lock @@ -0,0 +1,446 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@nodelib/fs.scandir@2.1.5": + version "2.1.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" + integrity sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g== + dependencies: + "@nodelib/fs.stat" "2.0.5" + run-parallel "^1.1.9" + +"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz#5bd262af94e9d25bd1e71b05deed44876a222e8b" + integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== + +"@nodelib/fs.walk@^1.2.3": + version "1.2.8" + resolved "https://registry.yarnpkg.com/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz#e95737e8bb6746ddedf69c556953494f196fe69a" + integrity sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg== + dependencies: + "@nodelib/fs.scandir" "2.1.5" + fastq "^1.6.0" + +"@types/json-schema@^7.0.9": + version "7.0.11" + resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.11.tgz#d421b6c527a3037f7c84433fd2c4229e016863d3" + integrity sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ== + +"@types/node@^16.11.10": + version "16.11.39" + resolved "https://registry.yarnpkg.com/@types/node/-/node-16.11.39.tgz#07223cd2bc332ad9d92135e3a522eebdee3b060e" + integrity sha512-K0MsdV42vPwm9L6UwhIxMAOmcvH/1OoVkZyCgEtVu4Wx7sElGloy/W7kMBNe/oJ7V/jW9BVt1F6RahH6e7tPXw== + +"@typescript-eslint/eslint-plugin@5.6.0": + version "5.6.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.6.0.tgz#efd8668b3d6627c46ce722c2afe813928fe120a0" + integrity sha512-MIbeMy5qfLqtgs1hWd088k1hOuRsN9JrHUPwVVKCD99EOUqScd7SrwoZl4Gso05EAP9w1kvLWUVGJOVpRPkDPA== + dependencies: + "@typescript-eslint/experimental-utils" "5.6.0" + "@typescript-eslint/scope-manager" "5.6.0" + debug "^4.3.2" + functional-red-black-tree "^1.0.1" + ignore "^5.1.8" + regexpp "^3.2.0" + semver "^7.3.5" + tsutils "^3.21.0" + +"@typescript-eslint/experimental-utils@5.6.0": + version "5.6.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/experimental-utils/-/experimental-utils-5.6.0.tgz#f3a5960f2004abdcac7bb81412bafc1560841c23" + integrity sha512-VDoRf3Qj7+W3sS/ZBXZh3LBzp0snDLEgvp6qj0vOAIiAPM07bd5ojQ3CTzF/QFl5AKh7Bh1ycgj6lFBJHUt/DA== + dependencies: + "@types/json-schema" "^7.0.9" + "@typescript-eslint/scope-manager" "5.6.0" + "@typescript-eslint/types" "5.6.0" + "@typescript-eslint/typescript-estree" "5.6.0" + eslint-scope "^5.1.1" + eslint-utils "^3.0.0" + +"@typescript-eslint/parser@5.6.0": + version "5.6.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-5.6.0.tgz#11677324659641400d653253c03dcfbed468d199" + integrity sha512-YVK49NgdUPQ8SpCZaOpiq1kLkYRPMv9U5gcMrywzI8brtwZjr/tG3sZpuHyODt76W/A0SufNjYt9ZOgrC4tLIQ== + dependencies: + "@typescript-eslint/scope-manager" "5.6.0" + "@typescript-eslint/types" "5.6.0" + "@typescript-eslint/typescript-estree" "5.6.0" + debug "^4.3.2" + +"@typescript-eslint/scope-manager@5.6.0": + version "5.6.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-5.6.0.tgz#9dd7f007dc8f3a34cdff6f79f5eaab27ae05157e" + integrity sha512-1U1G77Hw2jsGWVsO2w6eVCbOg0HZ5WxL/cozVSTfqnL/eB9muhb8THsP0G3w+BB5xAHv9KptwdfYFAUfzcIh4A== + dependencies: + "@typescript-eslint/types" "5.6.0" + "@typescript-eslint/visitor-keys" "5.6.0" + +"@typescript-eslint/types@5.6.0": + version "5.6.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-5.6.0.tgz#745cb1b59daadcc1f32f7be95f0f68accf38afdd" + integrity sha512-OIZffked7mXv4mXzWU5MgAEbCf9ecNJBKi+Si6/I9PpTaj+cf2x58h2oHW5/P/yTnPkKaayfjhLvx+crnl5ubA== + +"@typescript-eslint/typescript-estree@5.6.0": + version "5.6.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-5.6.0.tgz#dfbb19c9307fdd81bd9c650c67e8397821d7faf0" + integrity sha512-92vK5tQaE81rK7fOmuWMrSQtK1IMonESR+RJR2Tlc7w4o0MeEdjgidY/uO2Gobh7z4Q1hhS94Cr7r021fMVEeA== + dependencies: + "@typescript-eslint/types" "5.6.0" + "@typescript-eslint/visitor-keys" "5.6.0" + debug "^4.3.2" + globby "^11.0.4" + is-glob "^4.0.3" + semver "^7.3.5" + tsutils "^3.21.0" + +"@typescript-eslint/visitor-keys@5.6.0": + version "5.6.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-5.6.0.tgz#3e36509e103fe9713d8f035ac977235fd63cb6e6" + integrity sha512-1p7hDp5cpRFUyE3+lvA74egs+RWSgumrBpzBCDzfTFv0aQ7lIeay80yU0hIxgAhwQ6PcasW35kaOCyDOv6O/Ng== + dependencies: + "@typescript-eslint/types" "5.6.0" + eslint-visitor-keys "^3.0.0" + +array-union@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/array-union/-/array-union-2.1.0.tgz#b798420adbeb1de828d84acd8a2e23d3efe85e8d" + integrity sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw== + +balanced-match@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" + integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== + +brace-expansion@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.1.tgz#1edc459e0f0c548486ecf9fc99f2221364b9a0ae" + integrity sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA== + dependencies: + balanced-match "^1.0.0" + +braces@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.2.tgz#3454e1a462ee8d599e236df336cd9ea4f8afe107" + integrity sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A== + dependencies: + fill-range "^7.0.1" + +debug@^4.3.2: + version "4.3.4" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.4.tgz#1319f6579357f2338d3337d2cdd4914bb5dcc865" + integrity sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ== + dependencies: + ms "2.1.2" + +dir-glob@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/dir-glob/-/dir-glob-3.0.1.tgz#56dbf73d992a4a93ba1584f4534063fd2e41717f" + integrity sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA== + dependencies: + path-type "^4.0.0" + +eslint-scope@^5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/eslint-scope/-/eslint-scope-5.1.1.tgz#e786e59a66cb92b3f6c1fb0d508aab174848f48c" + integrity sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw== + dependencies: + esrecurse "^4.3.0" + estraverse "^4.1.1" + +eslint-utils@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/eslint-utils/-/eslint-utils-3.0.0.tgz#8aebaface7345bb33559db0a1f13a1d2d48c3672" + integrity sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA== + dependencies: + eslint-visitor-keys "^2.0.0" + +eslint-visitor-keys@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz#f65328259305927392c938ed44eb0a5c9b2bd303" + integrity sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw== + +eslint-visitor-keys@^3.0.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/eslint-visitor-keys/-/eslint-visitor-keys-3.3.0.tgz#f6480fa6b1f30efe2d1968aa8ac745b862469826" + integrity sha512-mQ+suqKJVyeuwGYHAdjMFqjCyfl8+Ldnxuyp3ldiMBFKkvytrXUZWaiPCEav8qDHKty44bD+qV1IP4T+w+xXRA== + +esrecurse@^4.3.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/esrecurse/-/esrecurse-4.3.0.tgz#7ad7964d679abb28bee72cec63758b1c5d2c9921" + integrity sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag== + dependencies: + estraverse "^5.2.0" + +estraverse@^4.1.1: + version "4.3.0" + resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-4.3.0.tgz#398ad3f3c5a24948be7725e83d11a7de28cdbd1d" + integrity sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw== + +estraverse@^5.2.0: + version "5.3.0" + resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-5.3.0.tgz#2eea5290702f26ab8fe5370370ff86c965d21123" + integrity sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA== + +fast-glob@^3.2.9: + version "3.2.11" + resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.2.11.tgz#a1172ad95ceb8a16e20caa5c5e56480e5129c1d9" + integrity sha512-xrO3+1bxSo3ZVHAnqzyuewYT6aMFHRAd4Kcs92MAonjwQZLsK9d0SF1IyQ3k5PoirxTW0Oe/RqFgMQ6TcNE5Ew== + dependencies: + "@nodelib/fs.stat" "^2.0.2" + "@nodelib/fs.walk" "^1.2.3" + glob-parent "^5.1.2" + merge2 "^1.3.0" + micromatch "^4.0.4" + +fastq@^1.6.0: + version "1.13.0" + resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.13.0.tgz#616760f88a7526bdfc596b7cab8c18938c36b98c" + integrity sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw== + dependencies: + reusify "^1.0.4" + +fill-range@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.0.1.tgz#1919a6a7c75fe38b2c7c77e5198535da9acdda40" + integrity sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ== + dependencies: + to-regex-range "^5.0.1" + +fs.realpath@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" + integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw== + +functional-red-black-tree@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz#1b0ab3bd553b2a0d6399d29c0e3ea0b252078327" + integrity sha512-dsKNQNdj6xA3T+QlADDA7mOSlX0qiMINjn0cgr+eGHGsbSHzTabcIogz2+p/iqP1Xs6EP/sS2SbqH+brGTbq0g== + +glob-parent@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" + integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== + dependencies: + is-glob "^4.0.1" + +glob@^8.0.3: + version "8.0.3" + resolved "https://registry.yarnpkg.com/glob/-/glob-8.0.3.tgz#415c6eb2deed9e502c68fa44a272e6da6eeca42e" + integrity sha512-ull455NHSHI/Y1FqGaaYFaLGkNMMJbavMrEGFXG/PGrg6y7sutWHUHrz6gy6WEBH6akM1M414dWKCNs+IhKdiQ== + dependencies: + fs.realpath "^1.0.0" + inflight "^1.0.4" + inherits "2" + minimatch "^5.0.1" + once "^1.3.0" + +globby@^11.0.4: + version "11.1.0" + resolved "https://registry.yarnpkg.com/globby/-/globby-11.1.0.tgz#bd4be98bb042f83d796f7e3811991fbe82a0d34b" + integrity sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g== + dependencies: + array-union "^2.1.0" + dir-glob "^3.0.1" + fast-glob "^3.2.9" + ignore "^5.2.0" + merge2 "^1.4.1" + slash "^3.0.0" + +ignore@^5.1.8, ignore@^5.2.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.2.0.tgz#6d3bac8fa7fe0d45d9f9be7bac2fc279577e345a" + integrity sha512-CmxgYGiEPCLhfLnpPp1MoRmifwEIOgjcHXxOBjv7mY96c+eWScsOP9c112ZyLdWHi0FxHjI+4uVhKYp/gcdRmQ== + +inflight@^1.0.4: + version "1.0.6" + resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" + integrity sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA== + dependencies: + once "^1.3.0" + wrappy "1" + +inherits@2: + version "2.0.4" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + +is-extglob@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2" + integrity sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ== + +is-glob@^4.0.1, is-glob@^4.0.3: + version "4.0.3" + resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-4.0.3.tgz#64f61e42cbbb2eec2071a9dac0b28ba1e65d5084" + integrity sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg== + dependencies: + is-extglob "^2.1.1" + +is-number@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" + integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== + +jsonc-parser@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.0.0.tgz#abdd785701c7e7eaca8a9ec8cf070ca51a745a22" + integrity sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA== + +lru-cache@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-6.0.0.tgz#6d6fe6570ebd96aaf90fcad1dafa3b2566db3a94" + integrity sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA== + dependencies: + yallist "^4.0.0" + +lunr@^2.3.9: + version "2.3.9" + resolved "https://registry.yarnpkg.com/lunr/-/lunr-2.3.9.tgz#18b123142832337dd6e964df1a5a7707b25d35e1" + integrity sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow== + +marked@^4.0.16: + version "4.0.16" + resolved "https://registry.yarnpkg.com/marked/-/marked-4.0.16.tgz#9ec18fc1a723032eb28666100344d9428cf7a264" + integrity sha512-wahonIQ5Jnyatt2fn8KqF/nIqZM8mh3oRu2+l5EANGMhu6RFjiSG52QNE2eWzFMI94HqYSgN184NurgNG6CztA== + +merge2@^1.3.0, merge2@^1.4.1: + version "1.4.1" + resolved "https://registry.yarnpkg.com/merge2/-/merge2-1.4.1.tgz#4368892f885e907455a6fd7dc55c0c9d404990ae" + integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== + +micromatch@^4.0.4: + version "4.0.5" + resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.5.tgz#bc8999a7cbbf77cdc89f132f6e467051b49090c6" + integrity sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA== + dependencies: + braces "^3.0.2" + picomatch "^2.3.1" + +minimatch@^5.0.1, minimatch@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-5.1.0.tgz#1717b464f4971b144f6aabe8f2d0b8e4511e09c7" + integrity sha512-9TPBGGak4nHfGZsPBohm9AWg6NoT7QTCehS3BIJABslyZbzxfV78QM2Y6+i741OPZIafFAaiiEMh5OyIrJPgtg== + dependencies: + brace-expansion "^2.0.1" + +ms@2.1.2: + version "2.1.2" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009" + integrity sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w== + +once@^1.3.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" + integrity sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w== + dependencies: + wrappy "1" + +path-type@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/path-type/-/path-type-4.0.0.tgz#84ed01c0a7ba380afe09d90a8c180dcd9d03043b" + integrity sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw== + +picomatch@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.1.tgz#3ba3833733646d9d3e4995946c1365a67fb07a42" + integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== + +queue-microtask@^1.2.2: + version "1.2.3" + resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" + integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== + +regexpp@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/regexpp/-/regexpp-3.2.0.tgz#0425a2768d8f23bad70ca4b90461fa2f1213e1b2" + integrity sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg== + +reusify@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.0.4.tgz#90da382b1e126efc02146e90845a88db12925d76" + integrity sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw== + +run-parallel@^1.1.9: + version "1.2.0" + resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" + integrity sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA== + dependencies: + queue-microtask "^1.2.2" + +semver@^7.3.5: + version "7.3.7" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.7.tgz#12c5b649afdbf9049707796e22a4028814ce523f" + integrity sha512-QlYTucUYOews+WeEujDoEGziz4K6c47V/Bd+LjSSYcA94p+DmINdf7ncaUinThfvZyu13lN9OY1XDxt8C0Tw0g== + dependencies: + lru-cache "^6.0.0" + +shiki@^0.10.1: + version "0.10.1" + resolved "https://registry.yarnpkg.com/shiki/-/shiki-0.10.1.tgz#6f9a16205a823b56c072d0f1a0bcd0f2646bef14" + integrity sha512-VsY7QJVzU51j5o1+DguUd+6vmCmZ5v/6gYu4vyYAhzjuNQU6P/vmSy4uQaOhvje031qQMiW0d2BwgMH52vqMng== + dependencies: + jsonc-parser "^3.0.0" + vscode-oniguruma "^1.6.1" + vscode-textmate "5.2.0" + +slash@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/slash/-/slash-3.0.0.tgz#6539be870c165adbd5240220dbe361f1bc4d4634" + integrity sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q== + +to-regex-range@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" + integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== + dependencies: + is-number "^7.0.0" + +tslib@^1.8.1: + version "1.14.1" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.14.1.tgz#cf2d38bdc34a134bcaf1091c41f6619e2f672d00" + integrity sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg== + +tsutils@^3.21.0: + version "3.21.0" + resolved "https://registry.yarnpkg.com/tsutils/-/tsutils-3.21.0.tgz#b48717d394cea6c1e096983eed58e9d61715b623" + integrity sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA== + dependencies: + tslib "^1.8.1" + +typedoc@^0.22.10: + version "0.22.17" + resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.22.17.tgz#bc51cc95f569040112504300831cdac4f8089b7b" + integrity sha512-h6+uXHVVCPDaANzjwzdsj9aePBjZiBTpiMpBBeyh1zcN2odVsDCNajz8zyKnixF93HJeGpl34j/70yoEE5BfNg== + dependencies: + glob "^8.0.3" + lunr "^2.3.9" + marked "^4.0.16" + minimatch "^5.1.0" + shiki "^0.10.1" + +typescript@4.5.2: + version "4.5.2" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.5.2.tgz#8ac1fba9f52256fdb06fb89e4122fa6a346c2998" + integrity sha512-5BlMof9H1yGt0P8/WF+wPNw6GfctgGjXp5hkblpyT+8rkASSmkUKMXrxR0Xg8ThVCi/JnHQiKXeBaEwCeQwMFw== + +vscode-oniguruma@^1.6.1: + version "1.6.2" + resolved "https://registry.yarnpkg.com/vscode-oniguruma/-/vscode-oniguruma-1.6.2.tgz#aeb9771a2f1dbfc9083c8a7fdd9cccaa3f386607" + integrity sha512-KH8+KKov5eS/9WhofZR8M8dMHWN2gTxjMsG4jd04YhpbPR91fUj7rYQ2/XjeHCJWbg7X++ApRIU9NUwM2vTvLA== + +vscode-textmate@5.2.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/vscode-textmate/-/vscode-textmate-5.2.0.tgz#01f01760a391e8222fe4f33fbccbd1ad71aed74e" + integrity sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ== + +wrappy@1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" + integrity sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8= + +yallist@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72" + integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A== diff --git a/docs/content/js-client/overview.md b/docs/content/js-client/overview.md new file mode 100644 index 0000000000..c2c96d617c --- /dev/null +++ b/docs/content/js-client/overview.md @@ -0,0 +1,79 @@ +# Medusa JS Client + +The [Medusa JS Client](https://www.npmjs.com/package/@medusajs/medusa-js) provides easy access to the Medusa API from a client written in Typescript. This reference guides you to learn what methods the client has and how you can use them. + +This client can be use as an alternative to directly interacting with the [REST APIs](https://docs.medusajs.com/api/store). + +## Installation + +To install the Medusa JS Client run the following command: + +```bash npm2yarn +npm install @medusajs/medusa-js +``` + +## Usage + +Import Medusa as a default import and initiate it: + +```js +import Medusa from "@medusajs/medusa-js" + +const medusa = new Medusa() +``` + +## How to Use this Reference + +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: + +```js +import Medusa from "@medusajs/medusa-js" + +const medusa = new Medusa() + +//use method +medusa.customers.create({ + //data +}) +``` + +The `customers` resource also has another resource `addresses` nested inside it with its own method that you can access similarly: + +```js +medusa.customers.addresses.addAddress({ + //data +}) +``` + +## Authentication + +Authentication can be achieved in two ways using the `medusa-js` client: either by utilizing API keys or by using cookie based authentication. Each method has its own unique use case. + +### Using API keys + +API keys can only be used for admin functionality in Medusa since only users of the admin system have API keys. Refer to the [Configuration](#configuration) section to learn how to add the API key to requests. + +### Using cookies + +Authentication using cookies is done automatically by Axios when authenticating using the [auth](/references/js-client/classes/AuthResource) endpoints. After authentication, all subsequent calls will be authenticated. + +## Configuration + +### Initialize with config object + +The package can be initialized with several options: + +```js +const medusa = new Medusa({ + maxRetries: 3, + baseUrl: "https://api.example.com", +}) +``` + +| Option | Default | Description | +| ------------ | ------------------------- | --------------------------------------------------------- | +| `maxRetries` | `0` | The amount of times a request is retried. | +| `baseUrl` | `'http://localhost:9000'` | The url to which requests are made to. | +| `apiKey` | `''` | Optional api key used for authenticating admin requests . | \ No newline at end of file diff --git a/docs/content/references/js-client/.nojekyll b/docs/content/references/js-client/.nojekyll new file mode 100644 index 0000000000..e2ac6616ad --- /dev/null +++ b/docs/content/references/js-client/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/content/references/js-client/classes/AddressesResource.md b/docs/content/references/js-client/classes/AddressesResource.md new file mode 100644 index 0000000000..8c0729a5f0 --- /dev/null +++ b/docs/content/references/js-client/classes/AddressesResource.md @@ -0,0 +1,77 @@ +# Class: AddressesResource + +## Hierarchy + +- `default` + + ↳ **`AddressesResource`** + +## Methods + +### addAddress + +▸ **addAddress**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/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.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/addresses.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/addresses.ts#L16) + +___ + +### deleteAddress + +▸ **deleteAddress**(`address_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/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.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/addresses.ts:29](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/addresses.ts#L29) + +___ + +### updateAddress + +▸ **updateAddress**(`address_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/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.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/addresses.ts:41](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/addresses.ts#L41) diff --git a/docs/content/references/js-client/classes/Admin.md b/docs/content/references/js-client/classes/Admin.md new file mode 100644 index 0000000000..6025323054 --- /dev/null +++ b/docs/content/references/js-client/classes/Admin.md @@ -0,0 +1,267 @@ +# Class: Admin + +## Hierarchy + +- `default` + + ↳ **`Admin`** + +## Properties + +### auth + +• **auth**: [`AdminAuthResource`](AdminAuthResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:30](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L30) + +___ + +### collections + +• **collections**: [`AdminCollectionsResource`](AdminCollectionsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:34](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L34) + +___ + +### customerGroups + +• **customerGroups**: [`AdminCustomerGroupsResource`](AdminCustomerGroupsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L32) + +___ + +### customers + +• **customers**: [`AdminCustomersResource`](AdminCustomersResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:31](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L31) + +___ + +### discounts + +• **discounts**: [`AdminDiscountsResource`](AdminDiscountsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L33) + +___ + +### draftOrders + +• **draftOrders**: [`AdminDraftOrdersResource`](AdminDraftOrdersResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L35) + +___ + +### giftCards + +• **giftCards**: [`AdminGiftCardsResource`](AdminGiftCardsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L36) + +___ + +### invites + +• **invites**: [`AdminInvitesResource`](AdminInvitesResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L37) + +___ + +### notes + +• **notes**: [`AdminNotesResource`](AdminNotesResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L38) + +___ + +### notifications + +• **notifications**: [`AdminNotificationsResource`](AdminNotificationsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L53) + +___ + +### orders + +• **orders**: [`AdminOrdersResource`](AdminOrdersResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L45) + +___ + +### priceLists + +• **priceLists**: [`AdminPriceListResource`](AdminPriceListResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L39) + +___ + +### productTags + +• **productTags**: [`AdminProductTagsResource`](AdminProductTagsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L41) + +___ + +### productTypes + +• **productTypes**: [`AdminProductTypesResource`](AdminProductTypesResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L42) + +___ + +### products + +• **products**: [`AdminProductsResource`](AdminProductsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L40) + +___ + +### regions + +• **regions**: [`AdminRegionsResource`](AdminRegionsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L52) + +___ + +### returnReasons + +• **returnReasons**: [`AdminReturnReasonsResource`](AdminReturnReasonsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L46) + +___ + +### returns + +• **returns**: [`AdminReturnsResource`](AdminReturnsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L44) + +___ + +### shippingOptions + +• **shippingOptions**: [`AdminShippingOptionsResource`](AdminShippingOptionsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L51) + +___ + +### shippingProfiles + +• **shippingProfiles**: [`AdminShippingProfilesResource`](AdminShippingProfilesResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L49) + +___ + +### store + +• **store**: [`AdminStoresResource`](AdminStoresResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L50) + +___ + +### swaps + +• **swaps**: [`AdminSwapsResource`](AdminSwapsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L48) + +___ + +### taxRates + +• **taxRates**: [`AdminTaxRatesResource`](AdminTaxRatesResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L54) + +___ + +### uploads + +• **uploads**: [`AdminUploadsResource`](AdminUploadsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L55) + +___ + +### users + +• **users**: [`AdminUsersResource`](AdminUsersResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L43) + +___ + +### variants + +• **variants**: [`AdminVariantsResource`](AdminVariantsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L47) diff --git a/docs/content/references/js-client/classes/AdminAuthResource.md b/docs/content/references/js-client/classes/AdminAuthResource.md new file mode 100644 index 0000000000..f9ce872d27 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminAuthResource.md @@ -0,0 +1,75 @@ +# Class: AdminAuthResource + +## Hierarchy + +- `default` + + ↳ **`AdminAuthResource`** + +## Methods + +### createSession + +▸ **createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal.md#adminauthres)\> + +**`description`** Creates an authenticated session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostAuthReq`](internal.AdminPostAuthReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal.md#adminauthres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/auth.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/auth.ts#L33) + +___ + +### deleteSession + +▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> + +**`description`** destroys an authenticated session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/auth.ts:22](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/auth.ts#L22) + +___ + +### getSession + +▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal.md#adminauthres)\> + +**`description`** Retrieves an authenticated session +Usually used to check if authenticated session is alive. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal.md#adminauthres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/auth.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/auth.ts#L12) diff --git a/docs/content/references/js-client/classes/AdminCollectionsResource.md b/docs/content/references/js-client/classes/AdminCollectionsResource.md new file mode 100644 index 0000000000..3b271dcab7 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminCollectionsResource.md @@ -0,0 +1,133 @@ +# Class: AdminCollectionsResource + +## Hierarchy + +- `default` + + ↳ **`AdminCollectionsResource`** + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\> + +**`description`** Creates a collection. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostCollectionsReq`](internal.AdminPostCollectionsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\> + +Created collection. + +#### Defined in + +[packages/medusa-js/src/resources/admin/collections.ts:20](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L20) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +**`description`** deletes a collection + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of collection to delete. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +Deleted response + +#### Defined in + +[packages/medusa-js/src/resources/admin/collections.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L50) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal.md#admincollectionslistres)\> + +**`description`** Lists collections matching a query + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `query?` | [`AdminGetCollectionsParams`](internal.AdminGetCollectionsParams.md) | Query for searching collections | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal.md#admincollectionslistres)\> + +a list of collections matching the query. + +#### Defined in + +[packages/medusa-js/src/resources/admin/collections.ts:72](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L72) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\> + +**`description`** get a collection + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the collection to retrieve. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\> + +the collection with the given id + +#### Defined in + +[packages/medusa-js/src/resources/admin/collections.ts:61](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L61) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\> + +**`description`** Updates a collection + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the collection to update. | +| `payload` | [`AdminPostCollectionsCollectionReq`](internal.AdminPostCollectionsCollectionReq.md) | update to apply to collection. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\> + +the updated collection. + +#### Defined in + +[packages/medusa-js/src/resources/admin/collections.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L35) diff --git a/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md b/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md new file mode 100644 index 0000000000..c0c8fa1d78 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md @@ -0,0 +1,196 @@ +# Class: AdminCustomerGroupsResource + +## Hierarchy + +- `default` + + ↳ **`AdminCustomerGroupsResource`** + +## Methods + +### addCustomers + +▸ **addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\> + +Add multiple customers to a customer group. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | customer group id | +| `payload` | [`AdminPostCustomerGroupsGroupCustomersBatchReq`](internal.AdminPostCustomerGroupsGroupCustomersBatchReq.md) | an object which contains an array of customer ids which will be added to the group | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/customer-groups.ts:112](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L112) + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\> + +Create a customer group. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`AdminPostCustomerGroupsReq`](internal.AdminPostCustomerGroupsReq.md) | customer group info | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/customer-groups.ts:26](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L26) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/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.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/customer-groups.ts:77](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L77) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal.md#admincustomergroupslistres)\> + +Lists customer groups. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `query?` | [`AdminGetCustomerGroupsParams`](internal.AdminGetCustomerGroupsParams.md) | optional | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal.md#admincustomergroupslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/customer-groups.ts:91](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L91) + +___ + +### listCustomers + +▸ **listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal.md#admincustomerslistres)\> + +List and count customers that belong to provided customer groups. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | customer group id | +| `query?` | [`AdminGetCustomersParams`](internal.AdminGetCustomersParams.md) | params for filtering customers | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal.md#admincustomerslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/customer-groups.ts:144](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L144) + +___ + +### removeCustomers + +▸ **removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\> + +Remove multiple customers from a customer group. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | customer group id | +| `payload` | [`AdminDeleteCustomerGroupsGroupCustomerBatchReq`](internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) | an object which contains an array of customers ids which will be removed from the group | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/customer-groups.ts:128](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L128) + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\> + +Retrieves a customer group. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | customer group id | +| `query?` | [`AdminGetCustomerGroupsGroupParams`](internal.AdminGetCustomerGroupsGroupParams.md) | pass query options such as "expand", "fields" etc. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/customer-groups.ts:41](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L41) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\> + +Updates a customer group + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | customer group id | +| `payload` | [`AdminPostCustomerGroupsGroupReq`](internal.AdminPostCustomerGroupsGroupReq.md) | data to update customer group with | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/customer-groups.ts:62](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L62) diff --git a/docs/content/references/js-client/classes/AdminCustomersResource.md b/docs/content/references/js-client/classes/AdminCustomersResource.md new file mode 100644 index 0000000000..dae02c6c83 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminCustomersResource.md @@ -0,0 +1,100 @@ +# Class: AdminCustomersResource + +## Hierarchy + +- `default` + + ↳ **`AdminCustomersResource`** + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\> + +Creates a customer + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`AdminPostCustomersReq`](internal.AdminPostCustomersReq.md) | information of customer | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/customers.ts:18](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customers.ts#L18) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal.md#admincustomerslistres)\> + +Lists customers + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `query?` | [`AdminGetCustomersParams`](internal.AdminGetCustomersParams.md) | optional | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal.md#admincustomerslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/customers.ts:59](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customers.ts#L59) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.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.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/customers.ts:46](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customers.ts#L46) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\> + +Updates a customer + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | customer id | +| `payload` | [`AdminPostCustomersCustomerReq`](internal.AdminPostCustomersCustomerReq.md) | data to update customer with | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/customers.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customers.ts#L32) diff --git a/docs/content/references/js-client/classes/AdminDiscountsResource.md b/docs/content/references/js-client/classes/AdminDiscountsResource.md new file mode 100644 index 0000000000..48363a13a2 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminDiscountsResource.md @@ -0,0 +1,342 @@ +# Class: AdminDiscountsResource + +## Hierarchy + +- `default` + + ↳ **`AdminDiscountsResource`** + +## Methods + +### addRegion + +▸ **addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +**`description`** Adds region to discount + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `regionId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:24](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L24) + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +**`description`** Creates discounts + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostDiscountsReq`](internal.AdminPostDiscountsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L36) + +___ + +### createCondition + +▸ **createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +**`description`** creates a discount condition + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discountId` | `string` | +| `payload` | [`AdminPostDiscountsDiscountConditions`](internal.AdminPostDiscountsDiscountConditions.md) | +| `query` | [`AdminPostDiscountsDiscountConditionsParams`](internal.AdminPostDiscountsDiscountConditionsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:145](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L145) + +___ + +### createDynamicCode + +▸ **createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +**`description`** Creates a dynamic discount code + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostDiscountsDiscountDynamicCodesReq`](internal.AdminPostDiscountsDiscountDynamicCodesReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:59](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L59) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +**`description`** Deletes a discount + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:71](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L71) + +___ + +### deleteCondition + +▸ **deleteCondition**(`discountId`, `conditionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +**`description`** Removes a condition from a discount + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discountId` | `string` | +| `conditionId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:184](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L184) + +___ + +### deleteDynamicCode + +▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +**`description`** Deletes a dynamic discount + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `code` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:82](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L82) + +___ + +### getCondition + +▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal.md#admindiscountconditionsres)\> + +**`description`** Gets a condition from a discount + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discountId` | `string` | +| `conditionId` | `string` | +| `query?` | [`AdminGetDiscountsDiscountConditionsConditionParams`](internal.AdminGetDiscountsDiscountConditionsConditionParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal.md#admindiscountconditionsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:196](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L196) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal.md#admindiscountslistres)\> + +**`description`** Lists discounts + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetDiscountsParams`](internal.AdminGetDiscountsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal.md#admindiscountslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:116](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L116) + +___ + +### removeRegion + +▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +**`description`** Removes a region from a discount + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `regionId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:133](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L133) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +**`description`** Retrieves a discount + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:94](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L94) + +___ + +### retrieveByCode + +▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +**`description`** Retrieves a discount by code + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:105](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L105) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +**`description`** Updates discount + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostDiscountsDiscountReq`](internal.AdminPostDiscountsDiscountReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:47](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L47) + +___ + +### updateCondition + +▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +**`description`** Updates a discount condition + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discountId` | `string` | +| `conditionId` | `string` | +| `payload` | [`AdminPostDiscountsDiscountConditionsCondition`](internal.AdminPostDiscountsDiscountConditionsCondition.md) | +| `query` | [`AdminPostDiscountsDiscountConditionsConditionParams`](internal.AdminPostDiscountsDiscountConditionsConditionParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/discounts.ts:164](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L164) diff --git a/docs/content/references/js-client/classes/AdminDraftOrdersResource.md b/docs/content/references/js-client/classes/AdminDraftOrdersResource.md new file mode 100644 index 0000000000..e2ad2b50a1 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminDraftOrdersResource.md @@ -0,0 +1,219 @@ +# Class: AdminDraftOrdersResource + +## Hierarchy + +- `default` + + ↳ **`AdminDraftOrdersResource`** + +## Methods + +### addLineItem + +▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\> + +**`description`** Add line item to draft order + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsReq`](internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/draft-orders.ts:29](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L29) + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\> + +**`description`** Creates a draft order + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal.AdminPostDraftOrdersDraftOrderReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/draft-orders.ts:19](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L19) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +**`description`** Delete draft order + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/draft-orders.ts:40](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L40) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal.md#admindraftorderslistres)\> + +**`description`** Lists draft orders + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetDraftOrdersParams`](internal.AdminGetDraftOrdersParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal.md#admindraftorderslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/draft-orders.ts:67](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L67) + +___ + +### markPaid + +▸ **markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal.md#adminpostdraftordersdraftorderregisterpaymentres)\> + +**`description`** Mark a draft order as paid + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal.md#adminpostdraftordersdraftorderregisterpaymentres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/draft-orders.ts:83](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L83) + +___ + +### removeLineItem + +▸ **removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\> + +**`description`** Remove line item + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `itemId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/draft-orders.ts:48](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L48) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\> + +**`description`** Retrieves a draft order + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/draft-orders.ts:59](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L59) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\> + +**`description`** Update draft order + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal.AdminPostDraftOrdersDraftOrderReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/draft-orders.ts:94](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L94) + +___ + +### updateLineItem + +▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\> + +**`description`** Update draft order line item + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `itemId` | `string` | +| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsItemReq`](internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/draft-orders.ts:105](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L105) diff --git a/docs/content/references/js-client/classes/AdminGiftCardsResource.md b/docs/content/references/js-client/classes/AdminGiftCardsResource.md new file mode 100644 index 0000000000..43c8987f81 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminGiftCardsResource.md @@ -0,0 +1,123 @@ +# Class: AdminGiftCardsResource + +## Hierarchy + +- `default` + + ↳ **`AdminGiftCardsResource`** + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\> + +**`description`** Creates a gift card + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostGiftCardsReq`](internal.AdminPostGiftCardsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L17) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +**`description`** Deletes a gift card + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/gift-cards.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L36) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal.md#admingiftcardslistres)\> + +**`description`** Lists gift cards + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetGiftCardsParams`](internal.AdminGetGiftCardsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal.md#admingiftcardslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/gift-cards.ts:52](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L52) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\> + +**`description`** Deletes a gift card + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/gift-cards.ts:44](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L44) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\> + +**`description`** Updates a gift card + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal.AdminPostGiftCardsGiftCardReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/gift-cards.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L25) diff --git a/docs/content/references/js-client/classes/AdminInvitesResource.md b/docs/content/references/js-client/classes/AdminInvitesResource.md new file mode 100644 index 0000000000..9384c0071c --- /dev/null +++ b/docs/content/references/js-client/classes/AdminInvitesResource.md @@ -0,0 +1,111 @@ +# Class: AdminInvitesResource + +## Hierarchy + +- `default` + + ↳ **`AdminInvitesResource`** + +## Methods + +### accept + +▸ **accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostInvitesInviteAcceptReq`](internal.AdminPostInvitesInviteAcceptReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/invites.ts:10](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L10) + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostInvitesPayload`](../modules/internal.md#adminpostinvitespayload) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/invites.ts:15](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L15) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/invites.ts:20](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L20) + +___ + +### list + +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal.md#adminlistinvitesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal.md#adminlistinvitesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/invites.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L25) + +___ + +### resend + +▸ **resend**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/invites.ts:30](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L30) diff --git a/docs/content/references/js-client/classes/AdminNotesResource.md b/docs/content/references/js-client/classes/AdminNotesResource.md new file mode 100644 index 0000000000..9a5132a05f --- /dev/null +++ b/docs/content/references/js-client/classes/AdminNotesResource.md @@ -0,0 +1,113 @@ +# Class: AdminNotesResource + +## Hierarchy + +- `default` + + ↳ **`AdminNotesResource`** + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostNotesReq`](internal.AdminPostNotesReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L14) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/notes.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L27) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal.md#adminnoteslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetNotesParams`](internal.AdminGetNotesParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal.md#adminnoteslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/notes.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L37) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/notes.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L32) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostNotesNoteReq`](internal.AdminPostNotesNoteReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/notes.ts:19](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L19) diff --git a/docs/content/references/js-client/classes/AdminNotificationsResource.md b/docs/content/references/js-client/classes/AdminNotificationsResource.md new file mode 100644 index 0000000000..020355d40a --- /dev/null +++ b/docs/content/references/js-client/classes/AdminNotificationsResource.md @@ -0,0 +1,50 @@ +# Class: AdminNotificationsResource + +## Hierarchy + +- `default` + + ↳ **`AdminNotificationsResource`** + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal.md#adminnotificationslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetNotificationsParams`](internal.AdminGetNotificationsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal.md#adminnotificationslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/notifications.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notifications.ts#L12) + +___ + +### resend + +▸ **resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal.md#adminnotificationsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostNotificationsNotificationResendReq`](internal.AdminPostNotificationsNotificationResendReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal.md#adminnotificationsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/notifications.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notifications.ts#L25) diff --git a/docs/content/references/js-client/classes/AdminOrdersResource.md b/docs/content/references/js-client/classes/AdminOrdersResource.md new file mode 100644 index 0000000000..b6129b0c8e --- /dev/null +++ b/docs/content/references/js-client/classes/AdminOrdersResource.md @@ -0,0 +1,601 @@ +# Class: AdminOrdersResource + +## Hierarchy + +- `default` + + ↳ **`AdminOrdersResource`** + +## Methods + +### addShippingMethod + +▸ **addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostOrdersOrderShippingMethodsReq`](internal.AdminPostOrdersOrderShippingMethodsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:153](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L153) + +___ + +### archive + +▸ **archive**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:162](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L162) + +___ + +### cancel + +▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:145](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L145) + +___ + +### cancelClaim + +▸ **cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `claimId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:226](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L226) + +___ + +### cancelClaimFulfillment + +▸ **cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `claimId` | `string` | +| `fulfillmentId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:117](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L117) + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `fulfillmentId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:98](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L98) + +___ + +### cancelSwap + +▸ **cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `swapId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:179](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L179) + +___ + +### cancelSwapFulfillment + +▸ **cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `swapId` | `string` | +| `fulfillmentId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:107](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L107) + +___ + +### capturePayment + +▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:72](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L72) + +___ + +### complete + +▸ **complete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:64](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L64) + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostOrdersReq`](internal.AdminPostOrdersReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L25) + +___ + +### createClaim + +▸ **createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostOrdersOrderClaimsReq`](internal.AdminPostOrdersOrderClaimsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:217](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L217) + +___ + +### createClaimShipment + +▸ **createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `claimId` | `string` | +| `payload` | [`AdminPostOrdersOrderClaimsClaimShipmentsReq`](internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:255](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L255) + +___ + +### createFulfillment + +▸ **createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostOrdersOrderFulfillmentsReq`](internal.AdminPostOrdersOrderFulfillmentsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:89](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L89) + +___ + +### createShipment + +▸ **createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostOrdersOrderShipmentReq`](internal.AdminPostOrdersOrderShipmentReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:127](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L127) + +___ + +### createSwap + +▸ **createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostOrdersOrderSwapsReq`](internal.AdminPostOrdersOrderSwapsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:170](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L170) + +___ + +### createSwapShipment + +▸ **createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `swapId` | `string` | +| `payload` | [`AdminPostOrdersOrderSwapsSwapShipmentsReq`](internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:198](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L198) + +___ + +### deleteMetadata + +▸ **deleteMetadata**(`id`, `key`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `key` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:265](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L265) + +___ + +### fulfillClaim + +▸ **fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `claimId` | `string` | +| `payload` | [`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:245](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L245) + +___ + +### fulfillSwap + +▸ **fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `swapId` | `string` | +| `payload` | [`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:188](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L188) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal.md#adminorderslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetOrdersParams`](internal.AdminGetOrdersParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal.md#adminorderslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L50) + +___ + +### processSwapPayment + +▸ **processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `swapId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:208](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L208) + +___ + +### refundPayment + +▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostOrdersOrderRefundsReq`](internal.AdminPostOrdersOrderRefundsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:80](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L80) + +___ + +### requestReturn + +▸ **requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostOrdersOrderReturnsReq`](internal.AdminPostOrdersOrderReturnsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:136](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L136) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:42](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L42) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostOrdersOrderReq`](internal.AdminPostOrdersOrderReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L33) + +___ + +### updateClaim + +▸ **updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `claimId` | `string` | +| `payload` | [`AdminPostOrdersOrderClaimsClaimReq`](internal.AdminPostOrdersOrderClaimsClaimReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/orders.ts:235](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L235) diff --git a/docs/content/references/js-client/classes/AdminPriceListResource.md b/docs/content/references/js-client/classes/AdminPriceListResource.md new file mode 100644 index 0000000000..3b0c7db9a0 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminPriceListResource.md @@ -0,0 +1,223 @@ +# Class: AdminPriceListResource + +## Hierarchy + +- `default` + + ↳ **`AdminPriceListResource`** + +## Methods + +### addPrices + +▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostPriceListPricesPricesReq`](internal.AdminPostPriceListPricesPricesReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/price-lists.ts:80](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L80) + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostPriceListsPriceListReq`](internal.AdminPostPriceListsPriceListReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/price-lists.ts:18](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L18) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/price-lists.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L35) + +___ + +### deletePrices + +▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal.AdminDeletePriceListPricesPricesReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/price-lists.ts:89](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L89) + +___ + +### deleteProductPrices + +▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `priceListId` | `string` | +| `productId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/price-lists.ts:98](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L98) + +___ + +### deleteVariantPrices + +▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `priceListId` | `string` | +| `variantId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/price-lists.ts:107](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L107) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal.md#adminpricelistslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetPriceListPaginationParams`](internal.AdminGetPriceListPaginationParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal.md#adminpricelistslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/price-lists.ts:51](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L51) + +___ + +### listProducts + +▸ **listProducts**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal.AdminGetPriceListsPriceListProductsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/price-lists.ts:65](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L65) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/price-lists.ts:43](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L43) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal.AdminPostPriceListsPriceListPriceListReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/price-lists.ts:26](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L26) diff --git a/docs/content/references/js-client/classes/AdminProductTagsResource.md b/docs/content/references/js-client/classes/AdminProductTagsResource.md new file mode 100644 index 0000000000..bb231ef67d --- /dev/null +++ b/docs/content/references/js-client/classes/AdminProductTagsResource.md @@ -0,0 +1,27 @@ +# Class: AdminProductTagsResource + +## Hierarchy + +- `default` + + ↳ **`AdminProductTagsResource`** + +## Methods + +### list + +▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal.md#adminproducttagslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetProductTagsParams`](internal.AdminGetProductTagsParams.md) | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal.md#adminproducttagslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/product-tags.ts:10](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/product-tags.ts#L10) diff --git a/docs/content/references/js-client/classes/AdminProductTypesResource.md b/docs/content/references/js-client/classes/AdminProductTypesResource.md new file mode 100644 index 0000000000..23fcf6eb80 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminProductTypesResource.md @@ -0,0 +1,27 @@ +# Class: AdminProductTypesResource + +## Hierarchy + +- `default` + + ↳ **`AdminProductTypesResource`** + +## Methods + +### list + +▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal.md#adminproducttypeslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetProductTypesParams`](internal.AdminGetProductTypesParams.md) | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal.md#adminproducttypeslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/product-types.ts:10](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/product-types.ts#L10) diff --git a/docs/content/references/js-client/classes/AdminProductsResource.md b/docs/content/references/js-client/classes/AdminProductsResource.md new file mode 100644 index 0000000000..c97f9392f4 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminProductsResource.md @@ -0,0 +1,309 @@ +# Class: AdminProductsResource + +## Hierarchy + +- `default` + + ↳ **`AdminProductsResource`** + +## Methods + +### addOption + +▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostProductsProductOptionsReq`](internal.AdminPostProductsProductOptionsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:121](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L121) + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostProductsReq`](internal.AdminPostProductsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:23](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L23) + +___ + +### createVariant + +▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostProductsProductVariantsReq`](internal.AdminPostProductsProductVariantsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:93](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L93) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal.md#adminproductsdeleteres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal.md#adminproductsdeleteres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:48](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L48) + +___ + +### deleteOption + +▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal.md#adminproductsdeleteoptionres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `optionId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal.md#adminproductsdeleteoptionres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:140](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L140) + +___ + +### deleteVariant + +▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal.md#adminproductsdeletevariantres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `variantId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal.md#adminproductsdeletevariantres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:112](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L112) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal.md#adminproductslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetProductsParams`](internal.AdminGetProductsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal.md#adminproductslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:56](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L56) + +___ + +### listTags + +▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal.md#adminproductslisttagsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal.md#adminproductslisttagsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:77](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L77) + +___ + +### listTypes + +▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal.md#adminproductslisttypesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal.md#adminproductslisttypesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:70](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L70) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:31](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L31) + +___ + +### setMetadata + +▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostProductsProductMetadataReq`](internal.AdminPostProductsProductMetadataReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:84](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L84) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostProductsProductReq`](internal.AdminPostProductsProductReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:39](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L39) + +___ + +### updateOption + +▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `optionId` | `string` | +| `payload` | [`AdminPostProductsProductOptionsOption`](internal.AdminPostProductsProductOptionsOption.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:130](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L130) + +___ + +### updateVariant + +▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `variantId` | `string` | +| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal.AdminPostProductsProductVariantsVariantReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/products.ts:102](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L102) diff --git a/docs/content/references/js-client/classes/AdminRegionsResource.md b/docs/content/references/js-client/classes/AdminRegionsResource.md new file mode 100644 index 0000000000..62f08eb376 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminRegionsResource.md @@ -0,0 +1,366 @@ +# Class: AdminRegionsResource + +## Hierarchy + +- `default` + + ↳ **`AdminRegionsResource`** + +## Methods + +### addCountry + +▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +**`description`** adds a country to the list of countries in a region + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | region id | +| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal.AdminPostRegionsRegionCountriesReq.md) | country data | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +updated region + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:120](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L120) + +___ + +### addFulfillmentProvider + +▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +**`description`** adds a fulfillment provider to a region + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | region id | +| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +updated region + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:152](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L152) + +___ + +### addPaymentProvider + +▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +**`description`** adds a payment provider to a region + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | region id | +| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +updated region + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:198](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L198) + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +**`description`** creates a region. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostRegionsReq`](internal.AdminPostRegionsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +created region. + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L25) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +**`description`** deletes a region + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of region to delete. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +Deleted response + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:52](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L52) + +___ + +### deleteCountry + +▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +**`description`** remove a country from a region's list of coutnries + +#### 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.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +updated region + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:136](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L136) + +___ + +### deleteFulfillmentProvider + +▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +**`description`** remove a fulfillment provider from a region + +#### 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.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +updated region + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:168](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L168) + +___ + +### deleteMetadata + +▸ **deleteMetadata**(`id`, `key`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +**`description`** delete a region's metadata key value pair + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | region id | +| `key` | `string` | metadata key | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +updated region + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:108](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L108) + +___ + +### deletePaymentProvider + +▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +**`description`** removes a payment provider from a region + +#### 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.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +updated region + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:214](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L214) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal.md#adminregionslistres)\> + +**`description`** lists regions matching a query + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `query?` | [`AdminGetRegionsParams`](internal.AdminGetRegionsParams.md) | query for searching regions | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal.md#adminregionslistres)\> + +a list of regions matching the query. + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:74](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L74) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +**`description`** get a region + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the region to retrieve. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +the region with the given id + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:63](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L63) + +___ + +### retrieveFulfillmentOptions + +▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> + +**`description`** retrieves the list of fulfillment options available in a region + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | region id | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> + +list of fulfillment options + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:183](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L183) + +___ + +### setMetadata + +▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +**`description`** adds metadata to a region + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | region id | +| `payload` | [`AdminPostRegionsRegionMetadata`](internal.AdminPostRegionsRegionMetadata.md) | metadata | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +updated region + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:92](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L92) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +**`description`** updates a region + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the region to update. | +| `payload` | [`AdminPostRegionsRegionReq`](internal.AdminPostRegionsRegionReq.md) | update to apply to region. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\> + +the updated region. + +#### Defined in + +[packages/medusa-js/src/resources/admin/regions.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L37) diff --git a/docs/content/references/js-client/classes/AdminReturnReasonsResource.md b/docs/content/references/js-client/classes/AdminReturnReasonsResource.md new file mode 100644 index 0000000000..8b6cd82769 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminReturnReasonsResource.md @@ -0,0 +1,132 @@ +# Class: AdminReturnReasonsResource + +## Hierarchy + +- `default` + + ↳ **`AdminReturnReasonsResource`** + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\> + +**`description`** Creates a return reason. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostReturnReasonsReq`](internal.AdminPostReturnReasonsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\> + +Created return reason. + +#### Defined in + +[packages/medusa-js/src/resources/admin/return-reasons.ts:18](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L18) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +**`description`** deletes a return reason + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of return reason to delete. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +Deleted response + +#### Defined in + +[packages/medusa-js/src/resources/admin/return-reasons.ts:48](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L48) + +___ + +### list + +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal.md#adminreturnreasonslistres)\> + +**`description`** Lists return reasons matching a query + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal.md#adminreturnreasonslistres)\> + +a list of return reasons matching the query. + +#### Defined in + +[packages/medusa-js/src/resources/admin/return-reasons.ts:69](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L69) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\> + +**`description`** retrieves a return reason + +#### 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.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\> + +the return reason with the given id + +#### Defined in + +[packages/medusa-js/src/resources/admin/return-reasons.ts:59](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L59) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\> + +**`description`** Updates a return reason + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the return reason to update. | +| `payload` | [`AdminPostReturnReasonsReasonReq`](internal.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\> + +the updated return reason. + +#### Defined in + +[packages/medusa-js/src/resources/admin/return-reasons.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L33) diff --git a/docs/content/references/js-client/classes/AdminReturnsResource.md b/docs/content/references/js-client/classes/AdminReturnsResource.md new file mode 100644 index 0000000000..71484b42e2 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminReturnsResource.md @@ -0,0 +1,83 @@ +# Class: AdminReturnsResource + +## Hierarchy + +- `default` + + ↳ **`AdminReturnsResource`** + +## Methods + +### cancel + +▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal.md#adminreturnscancelres)\> + +**`description`** cancels a return + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of return to cancel | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal.md#adminreturnscancelres)\> + +the order for which the return was canceled + +#### Defined in + +[packages/medusa-js/src/resources/admin/returns.ts:19](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/returns.ts#L19) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal.md#adminreturnslistres)\> + +**`description`** lists returns matching a query + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `query?` | [`AdminGetReturnsParams`](internal.AdminGetReturnsParams.md) | query for searching returns | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal.md#adminreturnslistres)\> + +a list of returns matching the query + +#### Defined in + +[packages/medusa-js/src/resources/admin/returns.ts:46](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/returns.ts#L46) + +___ + +### receive + +▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal.md#adminreturnsres)\> + +**`description`** receive a return + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the return to receive. | +| `payload` | [`AdminPostReturnsReturnReceiveReq`](internal.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal.md#adminreturnsres)\> + +the return + +#### Defined in + +[packages/medusa-js/src/resources/admin/returns.ts:31](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/returns.ts#L31) diff --git a/docs/content/references/js-client/classes/AdminShippingOptionsResource.md b/docs/content/references/js-client/classes/AdminShippingOptionsResource.md new file mode 100644 index 0000000000..d27a1c48d6 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminShippingOptionsResource.md @@ -0,0 +1,133 @@ +# Class: AdminShippingOptionsResource + +## Hierarchy + +- `default` + + ↳ **`AdminShippingOptionsResource`** + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\> + +**`description`** creates a shipping option. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostShippingOptionsReq`](internal.AdminPostShippingOptionsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\> + +created shipping option. + +#### Defined in + +[packages/medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L20) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +**`description`** deletes a shipping option + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of shipping option to delete. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +deleted response + +#### Defined in + +[packages/medusa-js/src/resources/admin/shipping-options.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L50) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal.md#adminshippingoptionslistres)\> + +**`description`** lists shipping options matching a query + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `query?` | [`AdminGetShippingOptionsParams`](internal.AdminGetShippingOptionsParams.md) | query for searching shipping options | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal.md#adminshippingoptionslistres)\> + +a list of shipping options matching the query. + +#### Defined in + +[packages/medusa-js/src/resources/admin/shipping-options.ts:72](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L72) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\> + +**`description`** get a shipping option + +#### 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.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\> + +the shipping option with the given id + +#### Defined in + +[packages/medusa-js/src/resources/admin/shipping-options.ts:61](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L61) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\> + +**`description`** updates a shipping option + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the shipping option to update. | +| `payload` | [`AdminPostShippingOptionsOptionReq`](internal.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\> + +the updated shipping option. + +#### Defined in + +[packages/medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L35) diff --git a/docs/content/references/js-client/classes/AdminShippingProfilesResource.md b/docs/content/references/js-client/classes/AdminShippingProfilesResource.md new file mode 100644 index 0000000000..0584ee03a4 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminShippingProfilesResource.md @@ -0,0 +1,112 @@ +# Class: AdminShippingProfilesResource + +## Hierarchy + +- `default` + + ↳ **`AdminShippingProfilesResource`** + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostShippingProfilesReq`](internal.AdminPostShippingProfilesReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L12) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/shipping-profiles.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L27) + +___ + +### list + +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal.md#adminshippingprofileslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal.md#adminshippingprofileslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/shipping-profiles.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L32) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostShippingProfilesProfileReq`](internal.AdminPostShippingProfilesProfileReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/shipping-profiles.ts:19](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L19) diff --git a/docs/content/references/js-client/classes/AdminStoresResource.md b/docs/content/references/js-client/classes/AdminStoresResource.md new file mode 100644 index 0000000000..67ae5411d5 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminStoresResource.md @@ -0,0 +1,154 @@ +# Class: AdminStoresResource + +## Hierarchy + +- `default` + + ↳ **`AdminStoresResource`** + +## Methods + +### addCurrency + +▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\> + +**`description`** adds a currency to the store. + +#### 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.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\> + +updated store. + +#### Defined in + +[packages/medusa-js/src/resources/admin/store.ts:31](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L31) + +___ + +### deleteCurrency + +▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\> + +**`description`** deletes a currency from the available store currencies + +#### 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.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\> + +updated store + +#### Defined in + +[packages/medusa-js/src/resources/admin/store.ts:45](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L45) + +___ + +### listPaymentProviders + +▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal.md#adminpaymentproviderslist)\> + +**`description`** Lists the store's payment providers + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal.md#adminpaymentproviderslist)\> + +a list of payment providers configured on the store + +#### Defined in + +[packages/medusa-js/src/resources/admin/store.ts:68](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L68) + +___ + +### listTaxProviders + +▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal.md#admintaxproviderslist)\> + +**`description`** Lists the store's payment providers + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal.md#admintaxproviderslist)\> + +a list of payment providers configured on the store + +#### Defined in + +[packages/medusa-js/src/resources/admin/store.ts:79](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L79) + +___ + +### retrieve + +▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\> + +**`description`** gets a medusa store + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\> + +a medusa store + +#### Defined in + +[packages/medusa-js/src/resources/admin/store.ts:57](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L57) + +___ + +### update + +▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\> + +**`description`** Updates the store + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`AdminPostStoreReq`](internal.AdminPostStoreReq.md) | update to apply to the store. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\> + +the updated store. + +#### Defined in + +[packages/medusa-js/src/resources/admin/store.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L17) diff --git a/docs/content/references/js-client/classes/AdminSwapsResource.md b/docs/content/references/js-client/classes/AdminSwapsResource.md new file mode 100644 index 0000000000..2caac196ee --- /dev/null +++ b/docs/content/references/js-client/classes/AdminSwapsResource.md @@ -0,0 +1,49 @@ +# Class: AdminSwapsResource + +## Hierarchy + +- `default` + + ↳ **`AdminSwapsResource`** + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal.md#adminswapslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetSwapsParams`](internal.AdminGetSwapsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal.md#adminswapslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/swaps.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/swaps.ts#L16) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal.md#adminswapsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal.md#adminswapsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/swaps.ts:11](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/swaps.ts#L11) diff --git a/docs/content/references/js-client/classes/AdminTaxRatesResource.md b/docs/content/references/js-client/classes/AdminTaxRatesResource.md new file mode 100644 index 0000000000..67006464b1 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminTaxRatesResource.md @@ -0,0 +1,254 @@ +# Class: AdminTaxRatesResource + +## Hierarchy + +- `default` + + ↳ **`AdminTaxRatesResource`** + +## Methods + +### addProductTypes + +▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal.AdminPostTaxRatesTaxRateProductTypesReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/tax-rates.ts:100](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L100) + +___ + +### addProducts + +▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal.AdminPostTaxRatesTaxRateProductsReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/tax-rates.ts:84](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L84) + +___ + +### addShippingOptions + +▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/tax-rates.ts:116](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L116) + +___ + +### create + +▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostTaxRatesReq`](internal.AdminPostTaxRatesReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/tax-rates.ts:53](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L53) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/tax-rates.ts:180](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L180) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal.md#admintaxrateslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetTaxRatesParams`](internal.AdminGetTaxRatesParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal.md#admintaxrateslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/tax-rates.ts:39](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L39) + +___ + +### removeProductTypes + +▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md) | +| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/tax-rates.ts:148](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L148) + +___ + +### removeProducts + +▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal.AdminDeleteTaxRatesTaxRateProductsReq.md) | +| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal.AdminDeleteTaxRatesTaxRateProductsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/tax-rates.ts:132](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L132) + +___ + +### removeShippingOptions + +▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) | +| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/tax-rates.ts:164](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L164) + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/tax-rates.ts:24](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L24) + +___ + +### update + +▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal.AdminPostTaxRatesTaxRateReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/tax-rates.ts:68](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L68) diff --git a/docs/content/references/js-client/classes/AdminUploadsResource.md b/docs/content/references/js-client/classes/AdminUploadsResource.md new file mode 100644 index 0000000000..8336f064f8 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminUploadsResource.md @@ -0,0 +1,43 @@ +# 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:7](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/uploads.ts#L7) + +## Methods + +### create + +▸ **create**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadRes`](../modules/internal.md#adminuploadres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `file` | [`IAdminPostUploadsFile`](internal.IAdminPostUploadsFile.md) | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadRes`](../modules/internal.md#adminuploadres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/uploads.ts:11](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/uploads.ts#L11) diff --git a/docs/content/references/js-client/classes/AdminUsersResource.md b/docs/content/references/js-client/classes/AdminUsersResource.md new file mode 100644 index 0000000000..4e6417f96b --- /dev/null +++ b/docs/content/references/js-client/classes/AdminUsersResource.md @@ -0,0 +1,178 @@ +# Class: AdminUsersResource + +## Hierarchy + +- `default` + + ↳ **`AdminUsersResource`** + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\> + +**`description`** creates a user with the provided information + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`AdminCreateUserPayload`](../modules/internal.md#admincreateuserpayload) | user creation request body | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\> + +created user + +#### Defined in + +[packages/medusa-js/src/resources/admin/users.ts:61](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L61) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +**`description`** deletes a user + +#### 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.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\> + +delete response + +#### Defined in + +[packages/medusa-js/src/resources/admin/users.ts:88](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L88) + +___ + +### list + +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal.md#adminuserslistres)\> + +**`description`** lists all users + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal.md#adminuserslistres)\> + +a list of all users + +#### Defined in + +[packages/medusa-js/src/resources/admin/users.ts:97](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L97) + +___ + +### resetPassword + +▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\> + +**`description`** resets the users password given the correct token. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`AdminResetPasswordRequest`](internal.AdminResetPasswordRequest.md) | reset password information. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/users.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L36) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/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.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\> + +the user + +#### Defined in + +[packages/medusa-js/src/resources/admin/users.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L50) + +___ + +### sendResetPasswordToken + +▸ **sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> + +**`description`** resets password by re-sending password token. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`AdminResetPasswordTokenRequest`](internal.AdminResetPasswordTokenRequest.md) | payload for generating reset-password token. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/users.ts:22](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L22) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\> + +**`description`** updates a given user + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the user to update | +| `payload` | [`AdminUpdateUserPayload`](../modules/internal.md#adminupdateuserpayload) | user update request body | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\> + +the updated user + +#### Defined in + +[packages/medusa-js/src/resources/admin/users.ts:73](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L73) diff --git a/docs/content/references/js-client/classes/AdminVariantsResource.md b/docs/content/references/js-client/classes/AdminVariantsResource.md new file mode 100644 index 0000000000..1b984352f3 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminVariantsResource.md @@ -0,0 +1,28 @@ +# Class: AdminVariantsResource + +## Hierarchy + +- `default` + + ↳ **`AdminVariantsResource`** + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal.md#adminvariantslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetVariantsParams`](internal.AdminGetVariantsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal.md#adminvariantslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/variants.ts:7](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/variants.ts#L7) diff --git a/docs/content/references/js-client/classes/AuthResource.md b/docs/content/references/js-client/classes/AuthResource.md new file mode 100644 index 0000000000..ed3796bbb0 --- /dev/null +++ b/docs/content/references/js-client/classes/AuthResource.md @@ -0,0 +1,76 @@ +# Class: AuthResource + +## Hierarchy + +- `default` + + ↳ **`AuthResource`** + +## Methods + +### authenticate + +▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal.md#storeauthres)\> + +**`description`** Authenticates a customer using email and password combination + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`StorePostAuthReq`](internal.StorePostAuthReq.md) | authentication payload | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal.md#storeauthres)\> + +#### Defined in + +[packages/medusa-js/src/resources/auth.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/auth.ts#L16) + +___ + +### exists + +▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal.md#storegetauthemailres)\> + +**`description`** Check if email exists + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `email` | `string` | is required | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal.md#storegetauthemailres)\> + +#### Defined in + +[packages/medusa-js/src/resources/auth.ts:38](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/auth.ts#L38) + +___ + +### getSession + +▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal.md#storeauthres)\> + +**`description`** Retrieves an authenticated session +Usually used to check if authenticated session is alive. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal.md#storeauthres)\> + +#### Defined in + +[packages/medusa-js/src/resources/auth.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/auth.ts#L27) diff --git a/docs/content/references/js-client/classes/CartsResource.md b/docs/content/references/js-client/classes/CartsResource.md new file mode 100644 index 0000000000..06ec840888 --- /dev/null +++ b/docs/content/references/js-client/classes/CartsResource.md @@ -0,0 +1,285 @@ +# 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/2eb2126f/packages/medusa-js/src/resources/carts.ts#L15) + +## Methods + +### addShippingMethod + +▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +Adds a shipping method to cart + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart_id` | `string` | Id of cart | +| `payload` | [`StorePostCartsCartShippingMethodReq`](internal.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L24) + +___ + +### complete + +▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal.md#storecompletecartres)\> + +Completes a cart. +Payment authorization is attempted and if more work is required, we simply return the cart for further updates. +If payment is authorized and order is not yet created, we make sure to do so. +The completion of a cart can be performed idempotently with a provided header Idempotency-Key. +If not provuided, we will generate one for the request. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart_id` | `string` | is required | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal.md#storecompletecartres)\> + +#### Defined in + +[packages/medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L43) + +___ + +### create + +▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +Creates a cart + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload?` | [`StorePostCartReq`](internal.StorePostCartReq.md) | is optional and can contain a region_id and items. The cart will contain the payload, if provided. Otherwise it will be empty | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L58) + +___ + +### createPaymentSessions + +▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/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.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L74) + +___ + +### deleteDiscount + +▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/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.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L89) + +___ + +### deletePaymentSession + +▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/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.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L106) + +___ + +### refreshPaymentSession + +▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/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.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L122) + +___ + +### retrieve + +▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/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.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L137) + +___ + +### setPaymentSession + +▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +Refreshes a payment session. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart_id` | `string` | is required | +| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L152) + +___ + +### update + +▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +Updates a cart + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart_id` | `string` | is required | +| `payload` | [`StorePostCartsCartReq`](internal.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L168) + +___ + +### updatePaymentSession + +▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +Updates the payment method + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart_id` | `string` | is required | +| `provider_id` | `string` | is required | +| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal.StorePostCartsCartPaymentSessionUpdateReq.md) | is required | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L185) diff --git a/docs/content/references/js-client/classes/CollectionsResource.md b/docs/content/references/js-client/classes/CollectionsResource.md new file mode 100644 index 0000000000..1353946dc6 --- /dev/null +++ b/docs/content/references/js-client/classes/CollectionsResource.md @@ -0,0 +1,53 @@ +# Class: CollectionsResource + +## Hierarchy + +- `default` + + ↳ **`CollectionsResource`** + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal.md#storecollectionslistres)\> + +**`description`** Retrieves a list of collections + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `query?` | [`StoreGetCollectionsParams`](internal.StoreGetCollectionsParams.md) | is optional. Can contain a limit and offset for the returned list | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal.md#storecollectionslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/collections.ts:28](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/collections.ts#L28) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal.md#storecollectionsres)\> + +**`description`** Retrieves a single collection + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the collection | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal.md#storecollectionsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/collections.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/collections.ts#L17) diff --git a/docs/content/references/js-client/classes/CustomerResource.md b/docs/content/references/js-client/classes/CustomerResource.md new file mode 100644 index 0000000000..16a0fdd53b --- /dev/null +++ b/docs/content/references/js-client/classes/CustomerResource.md @@ -0,0 +1,165 @@ +# Class: CustomerResource + +## Hierarchy + +- `default` + + ↳ **`CustomerResource`** + +## Properties + +### addresses + +• **addresses**: [`AddressesResource`](AddressesResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/customers.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L17) + +___ + +### paymentMethods + +• **paymentMethods**: [`PaymentMethodsResource`](PaymentMethodsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/customers.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L16) + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> + +Creates a customer + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`StorePostCustomersReq`](internal.StorePostCustomersReq.md) | information of customer | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/customers.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L25) + +___ + +### generatePasswordToken + +▸ **generatePasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> + +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.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> + +#### Defined in + +[packages/medusa-js/src/resources/customers.ts:100](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L100) + +___ + +### listOrders + +▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal.md#storecustomerslistordersres)\> + +Retrieve customer orders + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal.md#storecustomerslistordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/customers.ts:65](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L65) + +___ + +### resetPassword + +▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> + +Resets customer password + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal.StorePostCustomersCustomerPasswordTokenReq.md) | info used to reset customer password | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/customers.ts:85](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L85) + +___ + +### retrieve + +▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/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.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/customers.ts:38](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L38) + +___ + +### update + +▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> + +Updates a customer + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`StorePostCustomersCustomerReq`](internal.StorePostCustomersCustomerReq.md) | information to update customer with | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/customers.ts:51](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L51) diff --git a/docs/content/references/js-client/classes/GiftCardsResource.md b/docs/content/references/js-client/classes/GiftCardsResource.md new file mode 100644 index 0000000000..d141db3fcc --- /dev/null +++ b/docs/content/references/js-client/classes/GiftCardsResource.md @@ -0,0 +1,30 @@ +# Class: GiftCardsResource + +## Hierarchy + +- `default` + + ↳ **`GiftCardsResource`** + +## Methods + +### retrieve + +▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal.md#storegiftcardsres)\> + +**`description`** Retrieves a single GiftCard + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `code` | `string` | code of the gift card | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal.md#storegiftcardsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/gift-cards.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/gift-cards.ts#L12) diff --git a/docs/content/references/js-client/classes/LineItemsResource.md b/docs/content/references/js-client/classes/LineItemsResource.md new file mode 100644 index 0000000000..4a4f7ba2fb --- /dev/null +++ b/docs/content/references/js-client/classes/LineItemsResource.md @@ -0,0 +1,81 @@ +# Class: LineItemsResource + +## Hierarchy + +- `default` + + ↳ **`LineItemsResource`** + +## Methods + +### create + +▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +Creates a line-item for a cart + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart_id` | `string` | id of cart | +| `payload` | [`StorePostCartsCartLineItemsReq`](internal.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/line-items.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/line-items.ts#L17) + +___ + +### delete + +▸ **delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/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.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/line-items.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/line-items.ts#L50) + +___ + +### update + +▸ **update**(`cart_id`, `line_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.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.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/line-items.ts:34](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/line-items.ts#L34) diff --git a/docs/content/references/js-client/classes/OrdersResource.md b/docs/content/references/js-client/classes/OrdersResource.md new file mode 100644 index 0000000000..94280f681c --- /dev/null +++ b/docs/content/references/js-client/classes/OrdersResource.md @@ -0,0 +1,76 @@ +# Class: OrdersResource + +## Hierarchy + +- `default` + + ↳ **`OrdersResource`** + +## Methods + +### lookupOrder + +▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\> + +**`description`** Look up an order using order details + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`StoreGetOrdersParams`](internal.StoreGetOrdersParams.md) | details used to look up the order | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/orders.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/orders.ts#L35) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\> + +**`description`** Retrieves an order + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | is required | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/orders.ts:13](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/orders.ts#L13) + +___ + +### retrieveByCartId + +▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\> + +**`description`** Retrieves an order by cart id + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart_id` | `string` | is required | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\> + +#### Defined in + +[packages/medusa-js/src/resources/orders.ts:24](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/orders.ts#L24) diff --git a/docs/content/references/js-client/classes/PaymentMethodsResource.md b/docs/content/references/js-client/classes/PaymentMethodsResource.md new file mode 100644 index 0000000000..2cc919afd0 --- /dev/null +++ b/docs/content/references/js-client/classes/PaymentMethodsResource.md @@ -0,0 +1,30 @@ +# Class: PaymentMethodsResource + +## Hierarchy + +- `default` + + ↳ **`PaymentMethodsResource`** + +## Methods + +### list + +▸ **list**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal.md#storecustomerslistpaymentmethodsres)\> + +Lists customer payment methods + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of cart | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal.md#storecustomerslistpaymentmethodsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/payment-methods.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/payment-methods.ts#L12) diff --git a/docs/content/references/js-client/classes/ProductVariantsResource.md b/docs/content/references/js-client/classes/ProductVariantsResource.md new file mode 100644 index 0000000000..a82e7eb9fe --- /dev/null +++ b/docs/content/references/js-client/classes/ProductVariantsResource.md @@ -0,0 +1,53 @@ +# Class: ProductVariantsResource + +## Hierarchy + +- `default` + + ↳ **`ProductVariantsResource`** + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal.md#storevariantslistres)\> + +**`description`** Retrieves a list of of Product Variants + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`StoreGetVariantsParams`](internal.StoreGetVariantsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal.md#storevariantslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/product-variants.ts:28](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/product-variants.ts#L28) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal.md#storevariantsres)\> + +**`description`** Retrieves a single product variant + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | is required | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal.md#storevariantsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/product-variants.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/product-variants.ts#L17) diff --git a/docs/content/references/js-client/classes/ProductsResource.md b/docs/content/references/js-client/classes/ProductsResource.md new file mode 100644 index 0000000000..011c64d96a --- /dev/null +++ b/docs/content/references/js-client/classes/ProductsResource.md @@ -0,0 +1,86 @@ +# 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/2eb2126f/packages/medusa-js/src/resources/products.ts#L14) + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal.md#storeproductslistres)\> + +**`description`** Retrieves a list of products + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `query?` | [`StoreGetProductsParams`](internal.StoreGetProductsParams.md) | is optional. Can contain a limit and offset for the returned list | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal.md#storeproductslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/products.ts:47](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/products.ts#L47) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal.md#storeproductsres)\> + +**`description`** Retrieves a single Product + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | is required | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal.md#storeproductsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/products.ts:22](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/products.ts#L22) + +___ + +### search + +▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal.md#storepostsearchres)\> + +**`description`** Searches for products + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `searchOptions` | [`StorePostSearchReq`](internal.StorePostSearchReq.md) | is required | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal.md#storepostsearchres)\> + +#### Defined in + +[packages/medusa-js/src/resources/products.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/products.ts#L33) diff --git a/docs/content/references/js-client/classes/RegionsResource.md b/docs/content/references/js-client/classes/RegionsResource.md new file mode 100644 index 0000000000..1b8624da6b --- /dev/null +++ b/docs/content/references/js-client/classes/RegionsResource.md @@ -0,0 +1,52 @@ +# Class: RegionsResource + +## Hierarchy + +- `default` + + ↳ **`RegionsResource`** + +## Methods + +### list + +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal.md#storeregionslistres)\> + +**`description`** Retrieves a list of regions + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal.md#storeregionslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/regions.ts:11](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/regions.ts#L11) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal.md#storeregionsres)\> + +**`description`** Retrieves a region + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | is required | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal.md#storeregionsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/regions.ts:22](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/regions.ts#L22) diff --git a/docs/content/references/js-client/classes/ReturnReasonsResource.md b/docs/content/references/js-client/classes/ReturnReasonsResource.md new file mode 100644 index 0000000000..91d0f069d9 --- /dev/null +++ b/docs/content/references/js-client/classes/ReturnReasonsResource.md @@ -0,0 +1,52 @@ +# Class: ReturnReasonsResource + +## Hierarchy + +- `default` + + ↳ **`ReturnReasonsResource`** + +## Methods + +### list + +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/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.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal.md#storereturnreasonslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/return-reasons.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/return-reasons.ts#L25) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal.md#storereturnreasonsres)\> + +**`description`** Retrieves a single Return Reason + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | is required | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal.md#storereturnreasonsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/return-reasons.ts:15](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/return-reasons.ts#L15) diff --git a/docs/content/references/js-client/classes/ReturnsResource.md b/docs/content/references/js-client/classes/ReturnsResource.md new file mode 100644 index 0000000000..d2c3d47810 --- /dev/null +++ b/docs/content/references/js-client/classes/ReturnsResource.md @@ -0,0 +1,30 @@ +# Class: ReturnsResource + +## Hierarchy + +- `default` + + ↳ **`ReturnsResource`** + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal.md#storereturnsres)\> + +Creates a return request + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`StorePostReturnsReq`](internal.StorePostReturnsReq.md) | details needed to create a return | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal.md#storereturnsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/returns.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/returns.ts#L12) diff --git a/docs/content/references/js-client/classes/ShippingOptionsResource.md b/docs/content/references/js-client/classes/ShippingOptionsResource.md new file mode 100644 index 0000000000..85fde9a45c --- /dev/null +++ b/docs/content/references/js-client/classes/ShippingOptionsResource.md @@ -0,0 +1,53 @@ +# Class: ShippingOptionsResource + +## Hierarchy + +- `default` + + ↳ **`ShippingOptionsResource`** + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\> + +**`description`** Lists shiping options available + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`StoreGetShippingOptionsParams`](internal.StoreGetShippingOptionsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/shipping-options.ts#L27) + +___ + +### listCartOptions + +▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\> + +**`description`** Lists shiping options available for a cart + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cart_id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\> + +#### Defined in + +[packages/medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/shipping-options.ts#L16) diff --git a/docs/content/references/js-client/classes/SwapsResource.md b/docs/content/references/js-client/classes/SwapsResource.md new file mode 100644 index 0000000000..0391fd574a --- /dev/null +++ b/docs/content/references/js-client/classes/SwapsResource.md @@ -0,0 +1,53 @@ +# Class: SwapsResource + +## Hierarchy + +- `default` + + ↳ **`SwapsResource`** + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal.md#storeswapsres)\> + +**`description`** Creates a swap from a cart + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`StorePostSwapsReq`](internal.StorePostSwapsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal.md#storeswapsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/swaps.ts#L12) + +___ + +### retrieveByCartId + +▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal.md#storeswapsres)\> + +**`description`** Retrieves a swap by cart id + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart_id` | `string` | id of cart | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal.md#storeswapsres)\> + +#### Defined in + +[packages/medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/swaps.ts#L23) diff --git a/docs/content/references/js-client/classes/internal.AdditionalItem.md b/docs/content/references/js-client/classes/internal.AdditionalItem.md new file mode 100644 index 0000000000..527eb5e70e --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdditionalItem.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdditionalItem + +[internal](../modules/internal.md).AdditionalItem + +## Properties + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:112 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:111 diff --git a/docs/content/references/js-client/classes/internal.Address.md b/docs/content/references/js-client/classes/internal.Address.md new file mode 100644 index 0000000000..9d56fe244e --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Address.md @@ -0,0 +1,219 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Address + +[internal](../modules/internal.md).Address + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`Address`** + +## Properties + +### address\_1 + +• **address\_1**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:37 + +___ + +### address\_2 + +• **address\_2**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:38 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:46 + +___ + +### city + +• **city**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:39 + +___ + +### company + +• **company**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:34 + +___ + +### country + +• **country**: ``null`` \| [`Country`](internal.Country.md) + +#### Defined in + +packages/medusa/dist/models/address.d.ts:41 + +___ + +### country\_code + +• **country\_code**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:40 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### customer + +• **customer**: ``null`` \| [`Customer`](internal.Customer.md) + +#### Defined in + +packages/medusa/dist/models/address.d.ts:33 + +___ + +### customer\_id + +• **customer\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:32 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.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:35 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.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:36 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/address.d.ts:45 + +___ + +### phone + +• **phone**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:44 + +___ + +### postal\_code + +• **postal\_code**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:43 + +___ + +### province + +• **province**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:42 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.AddressCreatePayload.md b/docs/content/references/js-client/classes/internal.AddressCreatePayload.md new file mode 100644 index 0000000000..42224a0810 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AddressCreatePayload.md @@ -0,0 +1,117 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AddressCreatePayload + +[internal](../modules/internal.md).AddressCreatePayload + +## Properties + +### address\_1 + +• **address\_1**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:81 + +___ + +### address\_2 + +• **address\_2**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:82 + +___ + +### city + +• **city**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:83 + +___ + +### company + +• **company**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:80 + +___ + +### country\_code + +• **country\_code**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:84 + +___ + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:76 + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:77 + +___ + +### metadata + +• **metadata**: `object` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:79 + +___ + +### phone + +• **phone**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:78 + +___ + +### postal\_code + +• **postal\_code**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:86 + +___ + +### province + +• **province**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:85 diff --git a/docs/content/references/js-client/classes/internal.AddressPayload.md b/docs/content/references/js-client/classes/internal.AddressPayload.md new file mode 100644 index 0000000000..62ba20c3df --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AddressPayload.md @@ -0,0 +1,123 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AddressPayload + +[internal](../modules/internal.md).AddressPayload + +## Hierarchy + +- **`AddressPayload`** + + ↳ [`StorePostCustomersCustomerAddressesAddressReq`](internal.StorePostCustomersCustomerAddressesAddressReq.md) + +## Properties + +### address\_1 + +• `Optional` **address\_1**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:68 + +___ + +### address\_2 + +• `Optional` **address\_2**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:69 + +___ + +### city + +• `Optional` **city**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:70 + +___ + +### company + +• `Optional` **company**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:67 + +___ + +### country\_code + +• `Optional` **country\_code**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:71 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:63 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:64 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/types/common.d.ts:66 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:65 + +___ + +### postal\_code + +• `Optional` **postal\_code**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:73 + +___ + +### province + +• `Optional` **province**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:72 diff --git a/docs/content/references/js-client/classes/internal.AdminCreateCondition.md b/docs/content/references/js-client/classes/internal.AdminCreateCondition.md new file mode 100644 index 0000000000..4193e7e782 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminCreateCondition.md @@ -0,0 +1,93 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminCreateCondition + +[internal](../modules/internal.md).AdminCreateCondition + +## Hierarchy + +- [`AdminUpsertConditionsReq`](internal.AdminUpsertConditionsReq.md) + + ↳ **`AdminCreateCondition`** + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[customer_groups](internal.AdminUpsertConditionsReq.md#customer_groups) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:21 + +___ + +### operator + +• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:84 + +___ + +### product\_collections + +• `Optional` **product\_collections**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_collections](internal.AdminUpsertConditionsReq.md#product_collections) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:18 + +___ + +### product\_tags + +• `Optional` **product\_tags**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_tags](internal.AdminUpsertConditionsReq.md#product_tags) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:20 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_types](internal.AdminUpsertConditionsReq.md#product_types) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:19 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[products](internal.AdminUpsertConditionsReq.md#products) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:17 diff --git a/docs/content/references/js-client/classes/internal.AdminCreateUserRequest.md b/docs/content/references/js-client/classes/internal.AdminCreateUserRequest.md new file mode 100644 index 0000000000..d315df61eb --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminCreateUserRequest.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminCreateUserRequest + +[internal](../modules/internal.md).AdminCreateUserRequest + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/create-user.d.ts:46 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/create-user.d.ts:47 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/create-user.d.ts:48 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/create-user.d.ts:50 + +___ + +### role + +• `Optional` **role**: [`UserRoles`](../enums/internal.UserRoles.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/create-user.d.ts:49 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md b/docs/content/references/js-client/classes/internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md new file mode 100644 index 0000000000..7bb60ef0f9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteCustomerGroupsGroupCustomerBatchReq + +[internal](../modules/internal.md).AdminDeleteCustomerGroupsGroupCustomerBatchReq + +## Properties + +### customer\_ids + +• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal.CustomerGroupsBatchCustomer.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/delete-customers-batch.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal.AdminDeletePriceListPricesPricesReq.md b/docs/content/references/js-client/classes/internal.AdminDeletePriceListPricesPricesReq.md new file mode 100644 index 0000000000..d7e0d89aa5 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminDeletePriceListPricesPricesReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeletePriceListPricesPricesReq + +[internal](../modules/internal.md).AdminDeletePriceListPricesPricesReq + +## Properties + +### price\_ids + +• **price\_ids**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/delete-prices-batch.d.ts:42 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md new file mode 100644 index 0000000000..8cba611caa --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteTaxRatesTaxRateProductTypesParams + +[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateProductTypesParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:27 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md new file mode 100644 index 0000000000..8fd82602f6 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteTaxRatesTaxRateProductTypesReq + +[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateProductTypesReq + +## Properties + +### product\_types + +• **product\_types**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsParams.md b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsParams.md new file mode 100644 index 0000000000..efa10034a1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteTaxRatesTaxRateProductsParams + +[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateProductsParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:27 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsReq.md b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsReq.md new file mode 100644 index 0000000000..6d0fa1e1b3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteTaxRatesTaxRateProductsReq + +[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateProductsReq + +## Properties + +### products + +• **products**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md new file mode 100644 index 0000000000..6bace3d9db --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteTaxRatesTaxRateShippingOptionsParams + +[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateShippingOptionsParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:27 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md new file mode 100644 index 0000000000..c5dd5e7dea --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteTaxRatesTaxRateShippingOptionsReq + +[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateShippingOptionsReq + +## Properties + +### shipping\_options + +• **shipping\_options**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.AdminGetCollectionsPaginationParams.md b/docs/content/references/js-client/classes/internal.AdminGetCollectionsPaginationParams.md new file mode 100644 index 0000000000..181f30beb5 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetCollectionsPaginationParams.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetCollectionsPaginationParams + +[internal](../modules/internal.md).AdminGetCollectionsPaginationParams + +## Hierarchy + +- **`AdminGetCollectionsPaginationParams`** + + ↳ [`AdminGetCollectionsParams`](internal.AdminGetCollectionsParams.md) + +## Properties + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:31 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:32 diff --git a/docs/content/references/js-client/classes/internal.AdminGetCollectionsParams.md b/docs/content/references/js-client/classes/internal.AdminGetCollectionsParams.md new file mode 100644 index 0000000000..216a88e9a3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetCollectionsParams.md @@ -0,0 +1,101 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetCollectionsParams + +[internal](../modules/internal.md).AdminGetCollectionsParams + +## Hierarchy + +- [`AdminGetCollectionsPaginationParams`](internal.AdminGetCollectionsPaginationParams.md) + + ↳ **`AdminGetCollectionsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:37 + +___ + +### deleted\_at + +• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:39 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:36 + +___ + +### limit + +• **limit**: `number` + +#### Inherited from + +[AdminGetCollectionsPaginationParams](internal.AdminGetCollectionsPaginationParams.md).[limit](internal.AdminGetCollectionsPaginationParams.md#limit) + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:31 + +___ + +### offset + +• **offset**: `number` + +#### Inherited from + +[AdminGetCollectionsPaginationParams](internal.AdminGetCollectionsPaginationParams.md).[offset](internal.AdminGetCollectionsPaginationParams.md#offset) + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:32 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:40 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:35 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:38 diff --git a/docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsGroupParams.md b/docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsGroupParams.md new file mode 100644 index 0000000000..50dc8c5429 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsGroupParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetCustomerGroupsGroupParams + +[internal](../modules/internal.md).AdminGetCustomerGroupsGroupParams + +## Hierarchy + +- [`FindParams`](internal.FindParams.md) + + ↳ **`AdminGetCustomerGroupsGroupParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal.FindParams.md).[expand](internal.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:89 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal.FindParams.md).[fields](internal.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:90 diff --git a/docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsParams.md b/docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsParams.md new file mode 100644 index 0000000000..892fdefe9c --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsParams.md @@ -0,0 +1,123 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetCustomerGroupsParams + +[internal](../modules/internal.md).AdminGetCustomerGroupsParams + +## Hierarchy + +- [`FilterableCustomerGroupProps`](internal.FilterableCustomerGroupProps.md) + + ↳ **`AdminGetCustomerGroupsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Inherited from + +[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[created_at](internal.FilterableCustomerGroupProps.md#created_at) + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:7 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:37 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md) + +#### Inherited from + +[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[id](internal.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:36 + +___ + +### name + +• `Optional` **name**: `string`[] + +#### Inherited from + +[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[name](internal.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:35 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:34 + +___ + +### q + +• `Optional` **q**: `string` + +#### Inherited from + +[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[q](internal.FilterableCustomerGroupProps.md#q) + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:4 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Inherited from + +[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[updated_at](internal.FilterableCustomerGroupProps.md#updated_at) + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:6 diff --git a/docs/content/references/js-client/classes/internal.AdminGetCustomersParams.md b/docs/content/references/js-client/classes/internal.AdminGetCustomersParams.md new file mode 100644 index 0000000000..016924dadc --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetCustomersParams.md @@ -0,0 +1,71 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetCustomersParams + +[internal](../modules/internal.md).AdminGetCustomersParams + +## Hierarchy + +- [`AdminListCustomerSelector`](internal.AdminListCustomerSelector.md) + + ↳ **`AdminGetCustomersParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts:25 + +___ + +### groups + +• `Optional` **groups**: `string`[] + +#### Inherited from + +[AdminListCustomerSelector](internal.AdminListCustomerSelector.md).[groups](internal.AdminListCustomerSelector.md#groups) + +#### Defined in + +packages/medusa/dist/types/customers.d.ts:3 + +___ + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts:23 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts:24 + +___ + +### q + +• `Optional` **q**: `string` + +#### Inherited from + +[AdminListCustomerSelector](internal.AdminListCustomerSelector.md).[q](internal.AdminListCustomerSelector.md#q) + +#### Defined in + +packages/medusa/dist/types/customers.d.ts:2 diff --git a/docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountConditionsConditionParams.md b/docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountConditionsConditionParams.md new file mode 100644 index 0000000000..86a65fb0a8 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountConditionsConditionParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetDiscountsDiscountConditionsConditionParams + +[internal](../modules/internal.md).AdminGetDiscountsDiscountConditionsConditionParams + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/get-condition.d.ts:29 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/get-condition.d.ts:30 diff --git a/docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountRuleParams.md b/docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountRuleParams.md new file mode 100644 index 0000000000..e9fbe7a2ec --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountRuleParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetDiscountsDiscountRuleParams + +[internal](../modules/internal.md).AdminGetDiscountsDiscountRuleParams + +## Properties + +### allocation + +• `Optional` **allocation**: [`AllocationType`](../enums/internal.AllocationType.md) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:14 + +___ + +### type + +• `Optional` **type**: [`DiscountRuleType`](../enums/internal.DiscountRuleType.md) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:13 diff --git a/docs/content/references/js-client/classes/internal.AdminGetDiscountsParams.md b/docs/content/references/js-client/classes/internal.AdminGetDiscountsParams.md new file mode 100644 index 0000000000..2dfe0e51ed --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetDiscountsParams.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetDiscountsParams + +[internal](../modules/internal.md).AdminGetDiscountsParams + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:36 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:33 + +___ + +### is\_dynamic + +• `Optional` **is\_dynamic**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:32 + +___ + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:34 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:35 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:31 + +___ + +### rule + +• `Optional` **rule**: [`AdminGetDiscountsDiscountRuleParams`](internal.AdminGetDiscountsDiscountRuleParams.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:30 diff --git a/docs/content/references/js-client/classes/internal.AdminGetDraftOrdersParams.md b/docs/content/references/js-client/classes/internal.AdminGetDraftOrdersParams.md new file mode 100644 index 0000000000..8bd7aa753e --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetDraftOrdersParams.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetDraftOrdersParams + +[internal](../modules/internal.md).AdminGetDraftOrdersParams + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:23 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:24 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:22 diff --git a/docs/content/references/js-client/classes/internal.AdminGetGiftCardsParams.md b/docs/content/references/js-client/classes/internal.AdminGetGiftCardsParams.md new file mode 100644 index 0000000000..9082aebf3c --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetGiftCardsParams.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetGiftCardsParams + +[internal](../modules/internal.md).AdminGetGiftCardsParams + +## Properties + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:24 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:25 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal.AdminGetNotesParams.md b/docs/content/references/js-client/classes/internal.AdminGetNotesParams.md new file mode 100644 index 0000000000..dc8db3be32 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetNotesParams.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetNotesParams + +[internal](../modules/internal.md).AdminGetNotesParams + +## Properties + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/list-notes.d.ts:29 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/list-notes.d.ts:30 + +___ + +### resource\_id + +• `Optional` **resource\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/list-notes.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.AdminGetNotificationsParams.md b/docs/content/references/js-client/classes/internal.AdminGetNotificationsParams.md new file mode 100644 index 0000000000..a0c25d26d5 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetNotificationsParams.md @@ -0,0 +1,97 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetNotificationsParams + +[internal](../modules/internal.md).AdminGetNotificationsParams + +## Properties + +### event\_name + +• `Optional` **event\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:38 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:37 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:36 + +___ + +### include\_resends + +• `Optional` **include\_resends**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:42 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:34 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:35 + +___ + +### resource\_id + +• `Optional` **resource\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:40 + +___ + +### resource\_type + +• `Optional` **resource\_type**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:39 + +___ + +### to + +• `Optional` **to**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:41 diff --git a/docs/content/references/js-client/classes/internal.AdminGetOrdersParams.md b/docs/content/references/js-client/classes/internal.AdminGetOrdersParams.md new file mode 100644 index 0000000000..3fdf1ed71e --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetOrdersParams.md @@ -0,0 +1,263 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetOrdersParams + +[internal](../modules/internal.md).AdminGetOrdersParams + +## Hierarchy + +- [`AdminListOrdersSelector`](internal.AdminListOrdersSelector.md) + + ↳ **`AdminGetOrdersParams`** + +## Properties + +### canceled\_at + +• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[canceled_at](internal.AdminListOrdersSelector.md#canceled_at) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:17 + +___ + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[cart_id](internal.AdminListOrdersSelector.md#cart_id) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:11 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[created_at](internal.AdminListOrdersSelector.md#created_at) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:18 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[currency_code](internal.AdminListOrdersSelector.md#currency_code) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:15 + +___ + +### customer\_id + +• `Optional` **customer\_id**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[customer_id](internal.AdminListOrdersSelector.md#customer_id) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:12 + +___ + +### display\_id + +• `Optional` **display\_id**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[display_id](internal.AdminListOrdersSelector.md#display_id) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:10 + +___ + +### email + +• `Optional` **email**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[email](internal.AdminListOrdersSelector.md#email) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:13 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:47 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:48 + +___ + +### fulfillment\_status + +• `Optional` **fulfillment\_status**: `string`[] + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[fulfillment_status](internal.AdminListOrdersSelector.md#fulfillment_status) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:8 + +___ + +### id + +• `Optional` **id**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[id](internal.AdminListOrdersSelector.md#id) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:6 + +___ + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:46 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:45 + +___ + +### payment\_status + +• `Optional` **payment\_status**: `string`[] + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[payment_status](internal.AdminListOrdersSelector.md#payment_status) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:9 + +___ + +### q + +• `Optional` **q**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[q](internal.AdminListOrdersSelector.md#q) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:5 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[region_id](internal.AdminListOrdersSelector.md#region_id) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:14 + +___ + +### status + +• `Optional` **status**: `string`[] + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[status](internal.AdminListOrdersSelector.md#status) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:7 + +___ + +### tax\_rate + +• `Optional` **tax\_rate**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[tax_rate](internal.AdminListOrdersSelector.md#tax_rate) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:16 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Inherited from + +[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[updated_at](internal.AdminListOrdersSelector.md#updated_at) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:19 diff --git a/docs/content/references/js-client/classes/internal.AdminGetPriceListPaginationParams.md b/docs/content/references/js-client/classes/internal.AdminGetPriceListPaginationParams.md new file mode 100644 index 0000000000..54ded2a905 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetPriceListPaginationParams.md @@ -0,0 +1,193 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetPriceListPaginationParams + +[internal](../modules/internal.md).AdminGetPriceListPaginationParams + +## Hierarchy + +- [`FilterablePriceListProps`](internal.FilterablePriceListProps.md) + + ↳ **`AdminGetPriceListPaginationParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Inherited from + +[FilterablePriceListProps](internal.FilterablePriceListProps.md).[created_at](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.FilterablePriceListProps.md).[customer_groups](internal.FilterablePriceListProps.md#customer_groups) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:16 + +___ + +### deleted\_at + +• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Inherited from + +[FilterablePriceListProps](internal.FilterablePriceListProps.md).[deleted_at](internal.FilterablePriceListProps.md#deleted_at) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:21 + +___ + +### description + +• `Optional` **description**: `string` + +#### Inherited from + +[FilterablePriceListProps](internal.FilterablePriceListProps.md).[description](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:36 + +___ + +### id + +• `Optional` **id**: `string` + +#### Inherited from + +[FilterablePriceListProps](internal.FilterablePriceListProps.md).[id](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:35 + +___ + +### name + +• `Optional` **name**: `string` + +#### Inherited from + +[FilterablePriceListProps](internal.FilterablePriceListProps.md).[name](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:34 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:37 + +___ + +### q + +• `Optional` **q**: `string` + +#### Inherited from + +[FilterablePriceListProps](internal.FilterablePriceListProps.md).[q](internal.FilterablePriceListProps.md#q) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:13 + +___ + +### status + +• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md)[] + +#### Inherited from + +[FilterablePriceListProps](internal.FilterablePriceListProps.md).[status](internal.FilterablePriceListProps.md#status) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:14 + +___ + +### type + +• `Optional` **type**: [`PriceListType`](../enums/internal.PriceListType.md)[] + +#### Inherited from + +[FilterablePriceListProps](internal.FilterablePriceListProps.md).[type](internal.FilterablePriceListProps.md#type) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:18 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Inherited from + +[FilterablePriceListProps](internal.FilterablePriceListProps.md).[updated_at](internal.FilterablePriceListProps.md#updated_at) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:20 diff --git a/docs/content/references/js-client/classes/internal.AdminGetPriceListsPriceListProductsParams.md b/docs/content/references/js-client/classes/internal.AdminGetPriceListsPriceListProductsParams.md new file mode 100644 index 0000000000..c1644a539d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetPriceListsPriceListProductsParams.md @@ -0,0 +1,209 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetPriceListsPriceListProductsParams + +[internal](../modules/internal.md).AdminGetPriceListsPriceListProductsParams + +## Hierarchy + +- [`AdminGetProductsPaginationParams`](internal.AdminGetProductsPaginationParams.md) + + ↳ **`AdminGetPriceListsPriceListProductsParams`** + +## Properties + +### collection\_id + +• `Optional` **collection\_id**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:63 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:71 + +___ + +### deleted\_at + +• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:73 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:66 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[expand](internal.AdminGetProductsPaginationParams.md#expand) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:61 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[fields](internal.AdminGetProductsPaginationParams.md#fields) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:62 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:67 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:60 + +___ + +### is\_giftcard + +• `Optional` **is\_giftcard**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:68 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[limit](internal.AdminGetProductsPaginationParams.md#limit) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:60 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[offset](internal.AdminGetProductsPaginationParams.md#offset) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:59 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:70 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:61 + +___ + +### status + +• `Optional` **status**: [`ProductStatus`](../enums/internal.ProductStatus.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:62 + +___ + +### tags + +• `Optional` **tags**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:64 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:65 + +___ + +### type + +• `Optional` **type**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:69 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:72 diff --git a/docs/content/references/js-client/classes/internal.AdminGetProductTagsPaginationParams.md b/docs/content/references/js-client/classes/internal.AdminGetProductTagsPaginationParams.md new file mode 100644 index 0000000000..7a4c17aad9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetProductTagsPaginationParams.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetProductTagsPaginationParams + +[internal](../modules/internal.md).AdminGetProductTagsPaginationParams + +## Hierarchy + +- **`AdminGetProductTagsPaginationParams`** + + ↳ [`AdminGetProductTagsParams`](internal.AdminGetProductTagsParams.md) + +## Properties + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:30 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.AdminGetProductTagsParams.md b/docs/content/references/js-client/classes/internal.AdminGetProductTagsParams.md new file mode 100644 index 0000000000..c0cc57bcce --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetProductTagsParams.md @@ -0,0 +1,101 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetProductTagsParams + +[internal](../modules/internal.md).AdminGetProductTagsParams + +## Hierarchy + +- [`AdminGetProductTagsPaginationParams`](internal.AdminGetProductTagsPaginationParams.md) + + ↳ **`AdminGetProductTagsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:37 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:34 + +___ + +### limit + +• **limit**: `number` + +#### Inherited from + +[AdminGetProductTagsPaginationParams](internal.AdminGetProductTagsPaginationParams.md).[limit](internal.AdminGetProductTagsPaginationParams.md#limit) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:30 + +___ + +### offset + +• **offset**: `number` + +#### Inherited from + +[AdminGetProductTagsPaginationParams](internal.AdminGetProductTagsPaginationParams.md).[offset](internal.AdminGetProductTagsPaginationParams.md#offset) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:31 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:39 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:35 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:38 + +___ + +### value + +• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:36 diff --git a/docs/content/references/js-client/classes/internal.AdminGetProductTypesPaginationParams.md b/docs/content/references/js-client/classes/internal.AdminGetProductTypesPaginationParams.md new file mode 100644 index 0000000000..a56d3fd558 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetProductTypesPaginationParams.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetProductTypesPaginationParams + +[internal](../modules/internal.md).AdminGetProductTypesPaginationParams + +## Hierarchy + +- **`AdminGetProductTypesPaginationParams`** + + ↳ [`AdminGetProductTypesParams`](internal.AdminGetProductTypesParams.md) + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:30 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.AdminGetProductTypesParams.md b/docs/content/references/js-client/classes/internal.AdminGetProductTypesParams.md new file mode 100644 index 0000000000..14e110a16f --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetProductTypesParams.md @@ -0,0 +1,101 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetProductTypesParams + +[internal](../modules/internal.md).AdminGetProductTypesParams + +## Hierarchy + +- [`AdminGetProductTypesPaginationParams`](internal.AdminGetProductTypesPaginationParams.md) + + ↳ **`AdminGetProductTypesParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:37 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:34 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +[AdminGetProductTypesPaginationParams](internal.AdminGetProductTypesPaginationParams.md).[limit](internal.AdminGetProductTypesPaginationParams.md#limit) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:30 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +[AdminGetProductTypesPaginationParams](internal.AdminGetProductTypesPaginationParams.md).[offset](internal.AdminGetProductTypesPaginationParams.md#offset) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:31 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:39 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:35 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:38 + +___ + +### value + +• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:36 diff --git a/docs/content/references/js-client/classes/internal.AdminGetProductsPaginationParams.md b/docs/content/references/js-client/classes/internal.AdminGetProductsPaginationParams.md new file mode 100644 index 0000000000..d61b91facf --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetProductsPaginationParams.md @@ -0,0 +1,55 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetProductsPaginationParams + +[internal](../modules/internal.md).AdminGetProductsPaginationParams + +## Hierarchy + +- **`AdminGetProductsPaginationParams`** + + ↳ [`AdminGetPriceListsPriceListProductsParams`](internal.AdminGetPriceListsPriceListProductsParams.md) + + ↳ [`AdminGetProductsParams`](internal.AdminGetProductsParams.md) + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:61 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:62 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:60 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:59 diff --git a/docs/content/references/js-client/classes/internal.AdminGetProductsParams.md b/docs/content/references/js-client/classes/internal.AdminGetProductsParams.md new file mode 100644 index 0000000000..bc0ebc7cd5 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetProductsParams.md @@ -0,0 +1,219 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetProductsParams + +[internal](../modules/internal.md).AdminGetProductsParams + +## Hierarchy + +- [`AdminGetProductsPaginationParams`](internal.AdminGetProductsPaginationParams.md) + + ↳ **`AdminGetProductsParams`** + +## Properties + +### collection\_id + +• `Optional` **collection\_id**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:68 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:77 + +___ + +### deleted\_at + +• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:79 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:72 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[expand](internal.AdminGetProductsPaginationParams.md#expand) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:61 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[fields](internal.AdminGetProductsPaginationParams.md#fields) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:62 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:73 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:65 + +___ + +### is\_giftcard + +• `Optional` **is\_giftcard**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:74 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[limit](internal.AdminGetProductsPaginationParams.md#limit) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:60 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[offset](internal.AdminGetProductsPaginationParams.md#offset) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:59 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:76 + +___ + +### price\_list\_id + +• `Optional` **price\_list\_id**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:70 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:66 + +___ + +### status + +• `Optional` **status**: `ProductStatus`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:67 + +___ + +### tags + +• `Optional` **tags**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:69 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:71 + +___ + +### type + +• `Optional` **type**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:75 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:78 diff --git a/docs/content/references/js-client/classes/internal.AdminGetRegionsPaginationParams.md b/docs/content/references/js-client/classes/internal.AdminGetRegionsPaginationParams.md new file mode 100644 index 0000000000..032fa10ae0 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetRegionsPaginationParams.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetRegionsPaginationParams + +[internal](../modules/internal.md).AdminGetRegionsPaginationParams + +## Hierarchy + +- **`AdminGetRegionsPaginationParams`** + + ↳ [`AdminGetRegionsParams`](internal.AdminGetRegionsParams.md) + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:56 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:57 diff --git a/docs/content/references/js-client/classes/internal.AdminGetRegionsParams.md b/docs/content/references/js-client/classes/internal.AdminGetRegionsParams.md new file mode 100644 index 0000000000..88e932922f --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetRegionsParams.md @@ -0,0 +1,71 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetRegionsParams + +[internal](../modules/internal.md).AdminGetRegionsParams + +## Hierarchy + +- [`AdminGetRegionsPaginationParams`](internal.AdminGetRegionsPaginationParams.md) + + ↳ **`AdminGetRegionsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:60 + +___ + +### deleted\_at + +• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:62 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +[AdminGetRegionsPaginationParams](internal.AdminGetRegionsPaginationParams.md).[limit](internal.AdminGetRegionsPaginationParams.md#limit) + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:56 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +[AdminGetRegionsPaginationParams](internal.AdminGetRegionsPaginationParams.md).[offset](internal.AdminGetRegionsPaginationParams.md#offset) + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:57 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:61 diff --git a/docs/content/references/js-client/classes/internal.AdminGetRegionsRegionFulfillmentOptionsRes.md b/docs/content/references/js-client/classes/internal.AdminGetRegionsRegionFulfillmentOptionsRes.md new file mode 100644 index 0000000000..ca7efe7b94 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetRegionsRegionFulfillmentOptionsRes.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetRegionsRegionFulfillmentOptionsRes + +[internal](../modules/internal.md).AdminGetRegionsRegionFulfillmentOptionsRes + +## Properties + +### fulfillment\_options + +• **fulfillment\_options**: [`FulfillmentOption`](internal.FulfillmentOption.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/index.d.ts:20 diff --git a/docs/content/references/js-client/classes/internal.AdminGetReturnsParams.md b/docs/content/references/js-client/classes/internal.AdminGetReturnsParams.md new file mode 100644 index 0000000000..797acaff29 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetReturnsParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetReturnsParams + +[internal](../modules/internal.md).AdminGetReturnsParams + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/list-returns.d.ts:26 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/list-returns.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal.AdminGetShippingOptionsParams.md b/docs/content/references/js-client/classes/internal.AdminGetShippingOptionsParams.md new file mode 100644 index 0000000000..d31cfe51a7 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetShippingOptionsParams.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetShippingOptionsParams + +[internal](../modules/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:45 + +___ + +### is\_return + +• `Optional` **is\_return**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:44 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:43 diff --git a/docs/content/references/js-client/classes/internal.AdminGetSwapsParams.md b/docs/content/references/js-client/classes/internal.AdminGetSwapsParams.md new file mode 100644 index 0000000000..cb1ffc4f1d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetSwapsParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetSwapsParams + +[internal](../modules/internal.md).AdminGetSwapsParams + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:24 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.AdminGetTaxRatesParams.md b/docs/content/references/js-client/classes/internal.AdminGetTaxRatesParams.md new file mode 100644 index 0000000000..82ca520b00 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetTaxRatesParams.md @@ -0,0 +1,87 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetTaxRatesParams + +[internal](../modules/internal.md).AdminGetTaxRatesParams + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:38 + +___ + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:42 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:43 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:41 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:37 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:40 + +___ + +### rate + +• `Optional` **rate**: `number` \| [`NumericalComparisonOperator`](internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:39 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:36 diff --git a/docs/content/references/js-client/classes/internal.AdminGetTaxRatesTaxRateParams.md b/docs/content/references/js-client/classes/internal.AdminGetTaxRatesTaxRateParams.md new file mode 100644 index 0000000000..110b6cd2d1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetTaxRatesTaxRateParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetTaxRatesTaxRateParams + +[internal](../modules/internal.md).AdminGetTaxRatesTaxRateParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:24 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.AdminGetVariantsParams.md b/docs/content/references/js-client/classes/internal.AdminGetVariantsParams.md new file mode 100644 index 0000000000..1bc1319968 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminGetVariantsParams.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetVariantsParams + +[internal](../modules/internal.md).AdminGetVariantsParams + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:29 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:30 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.AdminListCustomerSelector.md b/docs/content/references/js-client/classes/internal.AdminListCustomerSelector.md new file mode 100644 index 0000000000..9f48d1419d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminListCustomerSelector.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminListCustomerSelector + +[internal](../modules/internal.md).AdminListCustomerSelector + +## Hierarchy + +- **`AdminListCustomerSelector`** + + ↳ [`AdminGetCustomersParams`](internal.AdminGetCustomersParams.md) + +## Properties + +### groups + +• `Optional` **groups**: `string`[] + +#### Defined in + +packages/medusa/dist/types/customers.d.ts:3 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/types/customers.d.ts:2 diff --git a/docs/content/references/js-client/classes/internal.AdminListOrdersSelector.md b/docs/content/references/js-client/classes/internal.AdminListOrdersSelector.md new file mode 100644 index 0000000000..a3c582aebd --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminListOrdersSelector.md @@ -0,0 +1,163 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminListOrdersSelector + +[internal](../modules/internal.md).AdminListOrdersSelector + +## Hierarchy + +- **`AdminListOrdersSelector`** + + ↳ [`AdminGetOrdersParams`](internal.AdminGetOrdersParams.md) + +## Properties + +### canceled\_at + +• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:17 + +___ + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:11 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:18 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:15 + +___ + +### customer\_id + +• `Optional` **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:12 + +___ + +### display\_id + +• `Optional` **display\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:10 + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:13 + +___ + +### fulfillment\_status + +• `Optional` **fulfillment\_status**: `string`[] + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:8 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:6 + +___ + +### payment\_status + +• `Optional` **payment\_status**: `string`[] + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:9 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:5 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:14 + +___ + +### status + +• `Optional` **status**: `string`[] + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:7 + +___ + +### tax\_rate + +• `Optional` **tax\_rate**: `string` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:16 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:19 diff --git a/docs/content/references/js-client/classes/internal.AdminPostAuthReq.md b/docs/content/references/js-client/classes/internal.AdminPostAuthReq.md new file mode 100644 index 0000000000..d9a663a816 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostAuthReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostAuthReq + +[internal](../modules/internal.md).AdminPostAuthReq + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/auth/create-session.d.ts:25 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/auth/create-session.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCollectionsCollectionReq.md b/docs/content/references/js-client/classes/internal.AdminPostCollectionsCollectionReq.md new file mode 100644 index 0000000000..158dcfce33 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostCollectionsCollectionReq.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostCollectionsCollectionReq + +[internal](../modules/internal.md).AdminPostCollectionsCollectionReq + +## Properties + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:39 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:40 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:38 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCollectionsReq.md b/docs/content/references/js-client/classes/internal.AdminPostCollectionsReq.md new file mode 100644 index 0000000000..aa6b1bb59e --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostCollectionsReq.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostCollectionsReq + +[internal](../modules/internal.md).AdminPostCollectionsReq + +## Properties + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:39 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:40 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:38 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupCustomersBatchReq.md b/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupCustomersBatchReq.md new file mode 100644 index 0000000000..0755cee9d7 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupCustomersBatchReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostCustomerGroupsGroupCustomersBatchReq + +[internal](../modules/internal.md).AdminPostCustomerGroupsGroupCustomersBatchReq + +## Properties + +### customer\_ids + +• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal.CustomerGroupsBatchCustomer.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/add-customers-batch.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupReq.md b/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupReq.md new file mode 100644 index 0000000000..d0960b3325 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostCustomerGroupsGroupReq + +[internal](../modules/internal.md).AdminPostCustomerGroupsGroupReq + +## Properties + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:27 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsReq.md b/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsReq.md new file mode 100644 index 0000000000..85ab073913 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostCustomerGroupsReq + +[internal](../modules/internal.md).AdminPostCustomerGroupsReq + +## Properties + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:26 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCustomersCustomerReq.md b/docs/content/references/js-client/classes/internal.AdminPostCustomersCustomerReq.md new file mode 100644 index 0000000000..25d70281e7 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostCustomersCustomerReq.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostCustomersCustomerReq + +[internal](../modules/internal.md).AdminPostCustomersCustomerReq + +## Properties + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:60 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:61 + +___ + +### groups + +• `Optional` **groups**: [`Group`](internal.Group.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:66 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:62 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:65 + +___ + +### password + +• `Optional` **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:63 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:64 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCustomersReq.md b/docs/content/references/js-client/classes/internal.AdminPostCustomersReq.md new file mode 100644 index 0000000000..f43ffb8951 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostCustomersReq.md @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostCustomersReq + +[internal](../modules/internal.md).AdminPostCustomersReq + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:28 + +___ + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:29 + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:30 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:33 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:31 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:32 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditions.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditions.md new file mode 100644 index 0000000000..3e6dbaa1b1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditions.md @@ -0,0 +1,93 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountConditions + +[internal](../modules/internal.md).AdminPostDiscountsDiscountConditions + +## Hierarchy + +- [`AdminUpsertConditionsReq`](internal.AdminUpsertConditionsReq.md) + + ↳ **`AdminPostDiscountsDiscountConditions`** + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[customer_groups](internal.AdminUpsertConditionsReq.md#customer_groups) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:21 + +___ + +### operator + +• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-condition.d.ts:53 + +___ + +### product\_collections + +• `Optional` **product\_collections**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_collections](internal.AdminUpsertConditionsReq.md#product_collections) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:18 + +___ + +### product\_tags + +• `Optional` **product\_tags**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_tags](internal.AdminUpsertConditionsReq.md#product_tags) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:20 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_types](internal.AdminUpsertConditionsReq.md#product_types) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:19 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[products](internal.AdminUpsertConditionsReq.md#products) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:17 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsCondition.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsCondition.md new file mode 100644 index 0000000000..dda2091105 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsCondition.md @@ -0,0 +1,83 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountConditionsCondition + +[internal](../modules/internal.md).AdminPostDiscountsDiscountConditionsCondition + +## Hierarchy + +- [`AdminUpsertConditionsReq`](internal.AdminUpsertConditionsReq.md) + + ↳ **`AdminPostDiscountsDiscountConditionsCondition`** + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[customer_groups](internal.AdminUpsertConditionsReq.md#customer_groups) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:21 + +___ + +### product\_collections + +• `Optional` **product\_collections**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_collections](internal.AdminUpsertConditionsReq.md#product_collections) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:18 + +___ + +### product\_tags + +• `Optional` **product\_tags**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_tags](internal.AdminUpsertConditionsReq.md#product_tags) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:20 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_types](internal.AdminUpsertConditionsReq.md#product_types) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:19 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[products](internal.AdminUpsertConditionsReq.md#products) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:17 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsConditionParams.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsConditionParams.md new file mode 100644 index 0000000000..6502912077 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsConditionParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountConditionsConditionParams + +[internal](../modules/internal.md).AdminPostDiscountsDiscountConditionsConditionParams + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-condition.d.ts:53 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-condition.d.ts:54 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsParams.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsParams.md new file mode 100644 index 0000000000..8d476ca517 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountConditionsParams + +[internal](../modules/internal.md).AdminPostDiscountsDiscountConditionsParams + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-condition.d.ts:56 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-condition.d.ts:57 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountDynamicCodesReq.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountDynamicCodesReq.md new file mode 100644 index 0000000000..d080d90381 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountDynamicCodesReq.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountDynamicCodesReq + +[internal](../modules/internal.md).AdminPostDiscountsDiscountDynamicCodesReq + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:27 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:29 + +___ + +### usage\_limit + +• **usage\_limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountReq.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountReq.md new file mode 100644 index 0000000000..fb3ce811bd --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountReq.md @@ -0,0 +1,97 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountReq + +[internal](../modules/internal.md).AdminPostDiscountsDiscountReq + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:56 + +___ + +### ends\_at + +• `Optional` **ends\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:60 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:58 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:64 + +___ + +### regions + +• `Optional` **regions**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:63 + +___ + +### rule + +• `Optional` **rule**: [`AdminUpdateDiscountRule`](internal.AdminUpdateDiscountRule.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:57 + +___ + +### starts\_at + +• `Optional` **starts\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:59 + +___ + +### usage\_limit + +• `Optional` **usage\_limit**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:62 + +___ + +### valid\_duration + +• `Optional` **valid\_duration**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:61 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountRule.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountRule.md new file mode 100644 index 0000000000..82f14dafb8 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountRule.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountRule + +[internal](../modules/internal.md).AdminPostDiscountsDiscountRule + +## Properties + +### allocation + +• **allocation**: [`AllocationType`](../enums/internal.AllocationType.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:80 + +___ + +### conditions + +• `Optional` **conditions**: [`AdminCreateCondition`](internal.AdminCreateCondition.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:81 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:77 + +___ + +### type + +• **type**: [`DiscountRuleType`](../enums/internal.DiscountRuleType.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:78 + +___ + +### value + +• **value**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:79 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsReq.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsReq.md new file mode 100644 index 0000000000..180b77852d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostDiscountsReq.md @@ -0,0 +1,107 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsReq + +[internal](../modules/internal.md).AdminPostDiscountsReq + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:65 + +___ + +### ends\_at + +• `Optional` **ends\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:70 + +___ + +### is\_disabled + +• **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:68 + +___ + +### is\_dynamic + +• **is\_dynamic**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:67 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:74 + +___ + +### regions + +• `Optional` **regions**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:73 + +___ + +### rule + +• **rule**: [`AdminPostDiscountsDiscountRule`](internal.AdminPostDiscountsDiscountRule.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:66 + +___ + +### starts\_at + +• `Optional` **starts\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:69 + +___ + +### usage\_limit + +• `Optional` **usage\_limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:72 + +___ + +### valid\_duration + +• `Optional` **valid\_duration**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:71 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md b/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md new file mode 100644 index 0000000000..bbd30c844d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDraftOrdersDraftOrderLineItemsItemReq + +[internal](../modules/internal.md).AdminPostDraftOrdersDraftOrderLineItemsItemReq + +## 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:42 + +___ + +### quantity + +• `Optional` **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:41 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:39 + +___ + +### unit\_price + +• `Optional` **unit\_price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:40 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md b/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md new file mode 100644 index 0000000000..233c8acc55 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDraftOrdersDraftOrderLineItemsReq + +[internal](../modules/internal.md).AdminPostDraftOrdersDraftOrderLineItemsReq + +## 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:48 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:47 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:44 + +___ + +### unit\_price + +• `Optional` **unit\_price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:45 + +___ + +### variant\_id + +• `Optional` **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:46 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderReq.md b/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderReq.md new file mode 100644 index 0000000000..5d463d6186 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderReq.md @@ -0,0 +1,87 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDraftOrdersDraftOrderReq + +[internal](../modules/internal.md).AdminPostDraftOrdersDraftOrderReq + +## Properties + +### billing\_address + +• `Optional` **billing\_address**: [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:61 + +___ + +### country\_code + +• `Optional` **country\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:59 + +___ + +### customer\_id + +• `Optional` **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:64 + +___ + +### discounts + +• `Optional` **discounts**: `Discount`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:63 + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:60 + +___ + +### no\_notification\_order + +• `Optional` **no\_notification\_order**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:65 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:58 + +___ + +### shipping\_address + +• `Optional` **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:62 diff --git a/docs/content/references/js-client/classes/internal.AdminPostGiftCardsGiftCardReq.md b/docs/content/references/js-client/classes/internal.AdminPostGiftCardsGiftCardReq.md new file mode 100644 index 0000000000..6a095e874f --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostGiftCardsGiftCardReq.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostGiftCardsGiftCardReq + +[internal](../modules/internal.md).AdminPostGiftCardsGiftCardReq + +## Properties + +### balance + +• `Optional` **balance**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:47 + +___ + +### ends\_at + +• `Optional` **ends\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:49 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:48 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:51 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:50 diff --git a/docs/content/references/js-client/classes/internal.AdminPostGiftCardsReq.md b/docs/content/references/js-client/classes/internal.AdminPostGiftCardsReq.md new file mode 100644 index 0000000000..e2ef81f897 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostGiftCardsReq.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostGiftCardsReq + +[internal](../modules/internal.md).AdminPostGiftCardsReq + +## Properties + +### ends\_at + +• `Optional` **ends\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:46 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:47 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:49 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:48 + +___ + +### value + +• `Optional` **value**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptReq.md b/docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptReq.md new file mode 100644 index 0000000000..a2542f8702 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInvitesInviteAcceptReq + +[internal](../modules/internal.md).AdminPostInvitesInviteAcceptReq + +## Properties + +### token + +• **token**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:48 + +___ + +### user + +• **user**: [`AdminPostInvitesInviteAcceptUserReq`](internal.AdminPostInvitesInviteAcceptUserReq.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:49 diff --git a/docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptUserReq.md b/docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptUserReq.md new file mode 100644 index 0000000000..d5a3e7db3e --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptUserReq.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInvitesInviteAcceptUserReq + +[internal](../modules/internal.md).AdminPostInvitesInviteAcceptUserReq + +## Properties + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:43 + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:44 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal.AdminPostInvitesReq.md b/docs/content/references/js-client/classes/internal.AdminPostInvitesReq.md new file mode 100644 index 0000000000..6cda3af301 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostInvitesReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInvitesReq + +[internal](../modules/internal.md).AdminPostInvitesReq + +## Properties + +### role + +• **role**: [`UserRoles`](../enums/internal.UserRoles.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/create-invite.d.ts:32 + +___ + +### user + +• **user**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/create-invite.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.AdminPostNotesNoteReq.md b/docs/content/references/js-client/classes/internal.AdminPostNotesNoteReq.md new file mode 100644 index 0000000000..b4f1c6214d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostNotesNoteReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostNotesNoteReq + +[internal](../modules/internal.md).AdminPostNotesNoteReq + +## Properties + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/update-note.d.ts:35 diff --git a/docs/content/references/js-client/classes/internal.AdminPostNotesReq.md b/docs/content/references/js-client/classes/internal.AdminPostNotesReq.md new file mode 100644 index 0000000000..b13de4005d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostNotesReq.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostNotesReq + +[internal](../modules/internal.md).AdminPostNotesReq + +## Properties + +### resource\_id + +• **resource\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/create-note.d.ts:37 + +___ + +### resource\_type + +• **resource\_type**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/create-note.d.ts:38 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/create-note.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal.AdminPostNotificationsNotificationResendReq.md b/docs/content/references/js-client/classes/internal.AdminPostNotificationsNotificationResendReq.md new file mode 100644 index 0000000000..385daf7c6e --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostNotificationsNotificationResendReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostNotificationsNotificationResendReq + +[internal](../modules/internal.md).AdminPostNotificationsNotificationResendReq + +## Properties + +### to + +• `Optional` **to**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/resend-notification.d.ts:32 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md new file mode 100644 index 0000000000..7b2c8be636 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderClaimsClaimFulfillmentsReq + +[internal](../modules/internal.md).AdminPostOrdersOrderClaimsClaimFulfillmentsReq + +## Properties + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:36 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:37 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimReq.md new file mode 100644 index 0000000000..54c0b670f7 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimReq.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderClaimsClaimReq + +[internal](../modules/internal.md).AdminPostOrdersOrderClaimsClaimReq + +## Properties + +### claim\_items + +• `Optional` **claim\_items**: `Item`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:84 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:87 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:86 + +___ + +### shipping\_methods + +• `Optional` **shipping\_methods**: `ShippingMethod`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:85 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md new file mode 100644 index 0000000000..7b6c130bcb --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderClaimsClaimShipmentsReq + +[internal](../modules/internal.md).AdminPostOrdersOrderClaimsClaimShipmentsReq + +## Properties + +### fulfillment\_id + +• **fulfillment\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:40 + +___ + +### tracking\_numbers + +• `Optional` **tracking\_numbers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:41 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsReq.md new file mode 100644 index 0000000000..11c97e4893 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsReq.md @@ -0,0 +1,97 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderClaimsReq + +[internal](../modules/internal.md).AdminPostOrdersOrderClaimsReq + +## Properties + +### additional\_items + +• `Optional` **additional\_items**: `AdditionalItem`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:132 + +___ + +### claim\_items + +• **claim\_items**: `Item`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:130 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:137 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:136 + +___ + +### refund\_amount + +• `Optional` **refund\_amount**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:134 + +___ + +### return\_shipping + +• `Optional` **return\_shipping**: `ReturnShipping` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:131 + +___ + +### shipping\_address + +• `Optional` **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:135 + +___ + +### shipping\_methods + +• `Optional` **shipping\_methods**: `ShippingMethod`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:133 + +___ + +### type + +• **type**: ``"replace"`` \| ``"refund"`` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:129 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderFulfillmentsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderFulfillmentsReq.md new file mode 100644 index 0000000000..c036e00869 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderFulfillmentsReq.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderFulfillmentsReq + +[internal](../modules/internal.md).AdminPostOrdersOrderFulfillmentsReq + +## Properties + +### items + +• **items**: [`Item`](internal.Item.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:48 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:50 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:49 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderRefundsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderRefundsReq.md new file mode 100644 index 0000000000..3ab38e8e28 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderRefundsReq.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderRefundsReq + +[internal](../modules/internal.md).AdminPostOrdersOrderRefundsReq + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:44 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:47 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:46 + +___ + +### reason + +• **reason**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReq.md new file mode 100644 index 0000000000..05ccfdded0 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReq.md @@ -0,0 +1,107 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderReq + +[internal](../modules/internal.md).AdminPostOrdersOrderReq + +## Properties + +### billing\_address + +• `Optional` **billing\_address**: [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:86 + +___ + +### customer\_id + +• `Optional` **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:91 + +___ + +### discounts + +• `Optional` **discounts**: `object`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:90 + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:85 + +___ + +### items + +• `Optional` **items**: `object`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:88 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:94 + +___ + +### payment\_method + +• `Optional` **payment\_method**: `PaymentMethod` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:92 + +___ + +### region + +• `Optional` **region**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:89 + +___ + +### shipping\_address + +• `Optional` **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:87 + +___ + +### shipping\_method + +• `Optional` **shipping\_method**: `ShippingMethod`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:93 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReturnsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReturnsReq.md new file mode 100644 index 0000000000..a609af6ce3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReturnsReq.md @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderReturnsReq + +[internal](../modules/internal.md).AdminPostOrdersOrderReturnsReq + +## Properties + +### items + +• **items**: [`OrdersReturnItem`](internal.OrdersReturnItem.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:68 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:72 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:70 + +___ + +### receive\_now + +• `Optional` **receive\_now**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:71 + +___ + +### refund + +• `Optional` **refund**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:73 + +___ + +### return\_shipping + +• `Optional` **return\_shipping**: [`ReturnShipping`](internal.ReturnShipping.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:69 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShipmentReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShipmentReq.md new file mode 100644 index 0000000000..70432f856d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShipmentReq.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderShipmentReq + +[internal](../modules/internal.md).AdminPostOrdersOrderShipmentReq + +## Properties + +### fulfillment\_id + +• **fulfillment\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-shipment.d.ts:42 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-shipment.d.ts:44 + +___ + +### tracking\_numbers + +• `Optional` **tracking\_numbers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-shipment.d.ts:43 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShippingMethodsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShippingMethodsReq.md new file mode 100644 index 0000000000..ed9c504e64 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShippingMethodsReq.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderShippingMethodsReq + +[internal](../modules/internal.md).AdminPostOrdersOrderShippingMethodsReq + +## 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:29 + +___ + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:28 + +___ + +### price + +• **price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsReq.md new file mode 100644 index 0000000000..009d3832f9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsReq.md @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderSwapsReq + +[internal](../modules/internal.md).AdminPostOrdersOrderSwapsReq + +## Properties + +### additional\_items + +• `Optional` **additional\_items**: [`AdditionalItem`](internal.AdditionalItem.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:91 + +___ + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:94 + +___ + +### custom\_shipping\_options + +• `Optional` **custom\_shipping\_options**: [`CustomShippingOption`](internal.CustomShippingOption.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:92 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:93 + +___ + +### return\_items + +• **return\_items**: `ReturnItem`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:89 + +___ + +### return\_shipping + +• `Optional` **return\_shipping**: `ReturnShipping` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:90 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md new file mode 100644 index 0000000000..e8a16b0c44 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderSwapsSwapFulfillmentsReq + +[internal](../modules/internal.md).AdminPostOrdersOrderSwapsSwapFulfillmentsReq + +## Properties + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:36 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:37 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md new file mode 100644 index 0000000000..25b287223b --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderSwapsSwapShipmentsReq + +[internal](../modules/internal.md).AdminPostOrdersOrderSwapsSwapShipmentsReq + +## Properties + +### fulfillment\_id + +• **fulfillment\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:43 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:45 + +___ + +### tracking\_numbers + +• `Optional` **tracking\_numbers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:44 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersReq.md new file mode 100644 index 0000000000..3c6f65f917 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostOrdersReq.md @@ -0,0 +1,117 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersReq + +[internal](../modules/internal.md).AdminPostOrdersReq + +## Properties + +### billing\_address + +• **billing\_address**: [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:103 + +___ + +### customer\_id + +• **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:108 + +___ + +### discounts + +• `Optional` **discounts**: `object`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:107 + +___ + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:102 + +___ + +### items + +• **items**: `object`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:105 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:111 + +___ + +### payment\_method + +• **payment\_method**: [`PaymentMethod`](internal.PaymentMethod.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:109 + +___ + +### region + +• **region**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:106 + +___ + +### shipping\_address + +• **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:104 + +___ + +### shipping\_method + +• `Optional` **shipping\_method**: `ShippingMethod`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:110 + +___ + +### status + +• `Optional` **status**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:101 diff --git a/docs/content/references/js-client/classes/internal.AdminPostPriceListPricesPricesReq.md b/docs/content/references/js-client/classes/internal.AdminPostPriceListPricesPricesReq.md new file mode 100644 index 0000000000..6ef02f8add --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostPriceListPricesPricesReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostPriceListPricesPricesReq + +[internal](../modules/internal.md).AdminPostPriceListPricesPricesReq + +## Properties + +### override + +• `Optional` **override**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:69 + +___ + +### prices + +• **prices**: [`AdminPriceListPricesUpdateReq`](internal.AdminPriceListPricesUpdateReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListPriceListReq.md b/docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListPriceListReq.md new file mode 100644 index 0000000000..ba63042d10 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListPriceListReq.md @@ -0,0 +1,87 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostPriceListsPriceListPriceListReq + +[internal](../modules/internal.md).AdminPostPriceListsPriceListPriceListReq + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `CustomerGroup`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:91 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:85 + +___ + +### ends\_at + +• `Optional` **ends\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:87 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:84 + +___ + +### prices + +• `Optional` **prices**: [`AdminPriceListPricesUpdateReq`](internal.AdminPriceListPricesUpdateReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:90 + +___ + +### starts\_at + +• `Optional` **starts\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:86 + +___ + +### status + +• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:88 + +___ + +### type + +• `Optional` **type**: [`PriceListType`](../enums/internal.PriceListType.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:89 diff --git a/docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListReq.md b/docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListReq.md new file mode 100644 index 0000000000..5dc196cfb9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListReq.md @@ -0,0 +1,87 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostPriceListsPriceListReq + +[internal](../modules/internal.md).AdminPostPriceListsPriceListReq + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `CustomerGroup`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:86 + +___ + +### description + +• **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:80 + +___ + +### ends\_at + +• `Optional` **ends\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:82 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:79 + +___ + +### prices + +• **prices**: [`AdminPriceListPricesCreateReq`](internal.AdminPriceListPricesCreateReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:85 + +___ + +### starts\_at + +• `Optional` **starts\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:81 + +___ + +### status + +• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:83 + +___ + +### type + +• **type**: [`PriceListType`](../enums/internal.PriceListType.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:84 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsProductMetadataReq.md b/docs/content/references/js-client/classes/internal.AdminPostProductsProductMetadataReq.md new file mode 100644 index 0000000000..b2e570caf4 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostProductsProductMetadataReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsProductMetadataReq + +[internal](../modules/internal.md).AdminPostProductsProductMetadataReq + +## Properties + +### key + +• **key**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/set-metadata.d.ts:38 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/set-metadata.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsOption.md b/docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsOption.md new file mode 100644 index 0000000000..b702ab7a6e --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsOption.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsProductOptionsOption + +[internal](../modules/internal.md).AdminPostProductsProductOptionsOption + +## Properties + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-option.d.ts:35 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsReq.md b/docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsReq.md new file mode 100644 index 0000000000..70b7f4267f --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsProductOptionsReq + +[internal](../modules/internal.md).AdminPostProductsProductOptionsReq + +## Properties + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/add-option.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsProductReq.md b/docs/content/references/js-client/classes/internal.AdminPostProductsProductReq.md new file mode 100644 index 0000000000..548b4c0f4a --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostProductsProductReq.md @@ -0,0 +1,217 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsProductReq + +[internal](../modules/internal.md).AdminPostProductsProductReq + +## Properties + +### collection\_id + +• `Optional` **collection\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:232 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:225 + +___ + +### discountable + +• `Optional` **discountable**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:226 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:229 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:237 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:239 + +___ + +### images + +• **images**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:227 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:236 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:242 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:243 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:241 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:240 + +___ + +### status + +• `Optional` **status**: `ProductStatus` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:230 + +___ + +### subtitle + +• `Optional` **subtitle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:224 + +___ + +### tags + +• `Optional` **tags**: `ProductTagReq`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:233 + +___ + +### thumbnail + +• `Optional` **thumbnail**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:228 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:223 + +___ + +### type + +• `Optional` **type**: `ProductTypeReq` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:231 + +___ + +### variants + +• `Optional` **variants**: `ProductVariantReq`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:234 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:235 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:238 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsReq.md b/docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsReq.md new file mode 100644 index 0000000000..a364dea090 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsReq.md @@ -0,0 +1,197 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsProductVariantsReq + +[internal](../modules/internal.md).AdminPostProductsProductVariantsReq + +## Properties + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:125 + +___ + +### barcode + +• `Optional` **barcode**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:122 + +___ + +### ean + +• `Optional` **ean**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:120 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:129 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:123 + +___ + +### inventory\_quantity + +• **inventory\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:124 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:128 + +___ + +### manage\_inventory + +• `Optional` **manage\_inventory**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:126 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:133 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:134 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:132 + +___ + +### options + +• **options**: [`ProductVariantOptionReq`](internal.ProductVariantOptionReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:136 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:131 + +___ + +### prices + +• **prices**: [`ProductVariantPricesCreateReq`](internal.ProductVariantPricesCreateReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:135 + +___ + +### sku + +• `Optional` **sku**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:119 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:118 + +___ + +### upc + +• `Optional` **upc**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:121 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:127 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:130 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsVariantReq.md b/docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsVariantReq.md new file mode 100644 index 0000000000..cc04afd4b9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsVariantReq.md @@ -0,0 +1,197 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsProductVariantsVariantReq + +[internal](../modules/internal.md).AdminPostProductsProductVariantsVariantReq + +## Properties + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:125 + +___ + +### barcode + +• `Optional` **barcode**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:122 + +___ + +### ean + +• `Optional` **ean**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:120 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:129 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:123 + +___ + +### inventory\_quantity + +• **inventory\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:124 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:128 + +___ + +### manage\_inventory + +• `Optional` **manage\_inventory**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:126 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:133 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:134 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:132 + +___ + +### options + +• **options**: `ProductVariantOptionReq`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:136 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:131 + +___ + +### prices + +• **prices**: [`ProductVariantPricesUpdateReq`](internal.ProductVariantPricesUpdateReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:135 + +___ + +### sku + +• `Optional` **sku**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:119 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:118 + +___ + +### upc + +• `Optional` **upc**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:121 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:127 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:130 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsReq.md b/docs/content/references/js-client/classes/internal.AdminPostProductsReq.md new file mode 100644 index 0000000000..b9aa7f17dc --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostProductsReq.md @@ -0,0 +1,237 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsReq + +[internal](../modules/internal.md).AdminPostProductsReq + +## Properties + +### collection\_id + +• `Optional` **collection\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:238 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:230 + +___ + +### discountable + +• **discountable**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:232 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:235 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:244 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:246 + +___ + +### images + +• `Optional` **images**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:233 + +___ + +### is\_giftcard + +• **is\_giftcard**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:231 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:243 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:249 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:250 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:248 + +___ + +### options + +• `Optional` **options**: [`ProductOptionReq`](internal.ProductOptionReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:240 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:247 + +___ + +### status + +• `Optional` **status**: `ProductStatus` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:236 + +___ + +### subtitle + +• `Optional` **subtitle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:229 + +___ + +### tags + +• `Optional` **tags**: [`ProductTagReq`](internal.ProductTagReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:239 + +___ + +### thumbnail + +• `Optional` **thumbnail**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:234 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:228 + +___ + +### type + +• `Optional` **type**: [`ProductTypeReq`](internal.ProductTypeReq.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:237 + +___ + +### variants + +• `Optional` **variants**: [`ProductVariantReq`](internal.ProductVariantReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:241 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:242 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:245 diff --git a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionCountriesReq.md b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionCountriesReq.md new file mode 100644 index 0000000000..80c57af7d7 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionCountriesReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostRegionsRegionCountriesReq + +[internal](../modules/internal.md).AdminPostRegionsRegionCountriesReq + +## Properties + +### country\_code + +• **country\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/add-country.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionFulfillmentProvidersReq.md b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionFulfillmentProvidersReq.md new file mode 100644 index 0000000000..4a788ee15c --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionFulfillmentProvidersReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostRegionsRegionFulfillmentProvidersReq + +[internal](../modules/internal.md).AdminPostRegionsRegionFulfillmentProvidersReq + +## Properties + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/add-fulfillment-provider.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionMetadata.md b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionMetadata.md new file mode 100644 index 0000000000..7d74865356 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionMetadata.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostRegionsRegionMetadata + +[internal](../modules/internal.md).AdminPostRegionsRegionMetadata + +## Properties + +### key + +• **key**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/set-metadata.d.ts:26 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/set-metadata.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionPaymentProvidersReq.md b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionPaymentProvidersReq.md new file mode 100644 index 0000000000..01d5ab3935 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionPaymentProvidersReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostRegionsRegionPaymentProvidersReq + +[internal](../modules/internal.md).AdminPostRegionsRegionPaymentProvidersReq + +## Properties + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/add-payment-provider.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionReq.md b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionReq.md new file mode 100644 index 0000000000..42470e1300 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionReq.md @@ -0,0 +1,107 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostRegionsRegionReq + +[internal](../modules/internal.md).AdminPostRegionsRegionReq + +## Properties + +### automatic\_taxes + +• `Optional` **automatic\_taxes**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:70 + +___ + +### countries + +• `Optional` **countries**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:74 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:66 + +___ + +### fulfillment\_providers + +• `Optional` **fulfillment\_providers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:73 + +___ + +### gift\_cards\_taxable + +• `Optional` **gift\_cards\_taxable**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:69 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:65 + +___ + +### payment\_providers + +• `Optional` **payment\_providers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:72 + +___ + +### tax\_code + +• `Optional` **tax\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:67 + +___ + +### tax\_provider\_id + +• `Optional` **tax\_provider\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:71 + +___ + +### tax\_rate + +• `Optional` **tax\_rate**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal.AdminPostRegionsReq.md b/docs/content/references/js-client/classes/internal.AdminPostRegionsReq.md new file mode 100644 index 0000000000..9dbf857194 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostRegionsReq.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostRegionsReq + +[internal](../modules/internal.md).AdminPostRegionsReq + +## Properties + +### countries + +• **countries**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:64 + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:59 + +___ + +### fulfillment\_providers + +• **fulfillment\_providers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:63 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:58 + +___ + +### payment\_providers + +• **payment\_providers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:62 + +___ + +### tax\_code + +• `Optional` **tax\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:60 + +___ + +### tax\_rate + +• **tax\_rate**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:61 diff --git a/docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReasonReq.md b/docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReasonReq.md new file mode 100644 index 0000000000..1f4288a3e3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReasonReq.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostReturnReasonsReasonReq + +[internal](../modules/internal.md).AdminPostReturnReasonsReasonReq + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:40 + +___ + +### label + +• `Optional` **label**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:38 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:41 + +___ + +### value + +• `Optional` **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReq.md b/docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReq.md new file mode 100644 index 0000000000..72e2ade71e --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReq.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostReturnReasonsReq + +[internal](../modules/internal.md).AdminPostReturnReasonsReq + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:48 + +___ + +### label + +• **label**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:46 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:49 + +___ + +### parent\_return\_reason\_id + +• `Optional` **parent\_return\_reason\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:47 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal.AdminPostReturnsReturnReceiveReq.md b/docs/content/references/js-client/classes/internal.AdminPostReturnsReturnReceiveReq.md new file mode 100644 index 0000000000..3cec0c3b6a --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostReturnsReturnReceiveReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostReturnsReturnReceiveReq + +[internal](../modules/internal.md).AdminPostReturnsReturnReceiveReq + +## Properties + +### items + +• **items**: `Item`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/receive-return.d.ts:48 + +___ + +### refund + +• `Optional` **refund**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/receive-return.d.ts:49 diff --git a/docs/content/references/js-client/classes/internal.AdminPostShippingOptionsOptionReq.md b/docs/content/references/js-client/classes/internal.AdminPostShippingOptionsOptionReq.md new file mode 100644 index 0000000000..70a00bb6e3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostShippingOptionsOptionReq.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostShippingOptionsOptionReq + +[internal](../modules/internal.md).AdminPostShippingOptionsOptionReq + +## Properties + +### admin\_only + +• `Optional` **admin\_only**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:63 + +___ + +### amount + +• `Optional` **amount**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:61 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:64 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:60 + +___ + +### requirements + +• **requirements**: `OptionRequirement`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:62 diff --git a/docs/content/references/js-client/classes/internal.AdminPostShippingOptionsReq.md b/docs/content/references/js-client/classes/internal.AdminPostShippingOptionsReq.md new file mode 100644 index 0000000000..680b20b4f1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostShippingOptionsReq.md @@ -0,0 +1,117 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostShippingOptionsReq + +[internal](../modules/internal.md).AdminPostShippingOptionsReq + +## Properties + +### admin\_only + +• `Optional` **admin\_only**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:86 + +___ + +### amount + +• `Optional` **amount**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:84 + +___ + +### data + +• **data**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:82 + +___ + +### is\_return + +• `Optional` **is\_return**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:87 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:88 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:78 + +___ + +### price\_type + +• **price\_type**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:83 + +___ + +### profile\_id + +• `Optional` **profile\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:81 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:80 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:79 + +___ + +### requirements + +• `Optional` **requirements**: [`OptionRequirement`](internal.OptionRequirement.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:85 diff --git a/docs/content/references/js-client/classes/internal.AdminPostShippingProfilesProfileReq.md b/docs/content/references/js-client/classes/internal.AdminPostShippingProfilesProfileReq.md new file mode 100644 index 0000000000..182d397fff --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostShippingProfilesProfileReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostShippingProfilesProfileReq + +[internal](../modules/internal.md).AdminPostShippingProfilesProfileReq + +## Properties + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.AdminPostShippingProfilesReq.md b/docs/content/references/js-client/classes/internal.AdminPostShippingProfilesReq.md new file mode 100644 index 0000000000..0050479d49 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostShippingProfilesReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostShippingProfilesReq + +[internal](../modules/internal.md).AdminPostShippingProfilesReq + +## Properties + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/create-shipping-profile.d.ts:32 diff --git a/docs/content/references/js-client/classes/internal.AdminPostStoreReq.md b/docs/content/references/js-client/classes/internal.AdminPostStoreReq.md new file mode 100644 index 0000000000..569d16177d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostStoreReq.md @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostStoreReq + +[internal](../modules/internal.md).AdminPostStoreReq + +## Properties + +### currencies + +• `Optional` **currencies**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/update-store.d.ts:47 + +___ + +### default\_currency\_code + +• `Optional` **default\_currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/update-store.d.ts:46 + +___ + +### invite\_link\_template + +• `Optional` **invite\_link\_template**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/update-store.d.ts:45 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/update-store.d.ts:42 + +___ + +### payment\_link\_template + +• `Optional` **payment\_link\_template**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/update-store.d.ts:44 + +___ + +### swap\_link\_template + +• `Optional` **swap\_link\_template**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/update-store.d.ts:43 diff --git a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesReq.md b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesReq.md new file mode 100644 index 0000000000..0c94ba3132 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesReq.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesReq + +[internal](../modules/internal.md).AdminPostTaxRatesReq + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:24 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:25 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:30 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:28 + +___ + +### rate + +• `Optional` **rate**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:27 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:26 + +___ + +### shipping\_options + +• `Optional` **shipping\_options**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:29 diff --git a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductTypesReq.md b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductTypesReq.md new file mode 100644 index 0000000000..f6b08242d4 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductTypesReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesTaxRateProductTypesReq + +[internal](../modules/internal.md).AdminPostTaxRatesTaxRateProductTypesReq + +## Properties + +### product\_types + +• **product\_types**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/add-to-product-types.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductsReq.md b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductsReq.md new file mode 100644 index 0000000000..9c5c2f8c86 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductsReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesTaxRateProductsReq + +[internal](../modules/internal.md).AdminPostTaxRatesTaxRateProductsReq + +## Properties + +### products + +• **products**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/add-to-products.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateReq.md b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateReq.md new file mode 100644 index 0000000000..1a61d4ef75 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateReq.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesTaxRateReq + +[internal](../modules/internal.md).AdminPostTaxRatesTaxRateReq + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:24 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:25 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:30 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:28 + +___ + +### rate + +• `Optional` **rate**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:27 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:26 + +___ + +### shipping\_options + +• `Optional` **shipping\_options**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:29 diff --git a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md new file mode 100644 index 0000000000..0eb105754f --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesTaxRateShippingOptionsReq + +[internal](../modules/internal.md).AdminPostTaxRatesTaxRateShippingOptionsReq + +## Properties + +### shipping\_options + +• **shipping\_options**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/add-to-shipping-options.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.AdminPriceListPricesCreateReq.md b/docs/content/references/js-client/classes/internal.AdminPriceListPricesCreateReq.md new file mode 100644 index 0000000000..085f1d7f1a --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPriceListPricesCreateReq.md @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPriceListPricesCreateReq + +[internal](../modules/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/docs/content/references/js-client/classes/internal.AdminPriceListPricesUpdateReq.md b/docs/content/references/js-client/classes/internal.AdminPriceListPricesUpdateReq.md new file mode 100644 index 0000000000..15ac9af22a --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminPriceListPricesUpdateReq.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPriceListPricesUpdateReq + +[internal](../modules/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/docs/content/references/js-client/classes/internal.AdminRegionsRes.md b/docs/content/references/js-client/classes/internal.AdminRegionsRes.md new file mode 100644 index 0000000000..3750b2ce6e --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminRegionsRes.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminRegionsRes + +[internal](../modules/internal.md).AdminRegionsRes + +## Properties + +### region + +• **region**: [`Region`](internal.Region.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/index.d.ts:9 diff --git a/docs/content/references/js-client/classes/internal.AdminResetPasswordRequest.md b/docs/content/references/js-client/classes/internal.AdminResetPasswordRequest.md new file mode 100644 index 0000000000..e6a25356a3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminResetPasswordRequest.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminResetPasswordRequest + +[internal](../modules/internal.md).AdminResetPasswordRequest + +## Properties + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/reset-password.d.ts:45 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/reset-password.d.ts:47 + +___ + +### token + +• **token**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/reset-password.d.ts:46 diff --git a/docs/content/references/js-client/classes/internal.AdminResetPasswordTokenRequest.md b/docs/content/references/js-client/classes/internal.AdminResetPasswordTokenRequest.md new file mode 100644 index 0000000000..d3f38fb1e6 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminResetPasswordTokenRequest.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminResetPasswordTokenRequest + +[internal](../modules/internal.md).AdminResetPasswordTokenRequest + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/reset-password-token.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal.AdminUpdateDiscountRule.md b/docs/content/references/js-client/classes/internal.AdminUpdateDiscountRule.md new file mode 100644 index 0000000000..77506f023b --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminUpdateDiscountRule.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminUpdateDiscountRule + +[internal](../modules/internal.md).AdminUpdateDiscountRule + +## Properties + +### allocation + +• `Optional` **allocation**: [`AllocationType`](../enums/internal.AllocationType.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:70 + +___ + +### conditions + +• `Optional` **conditions**: [`AdminUpsertCondition`](internal.AdminUpsertCondition.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:71 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:68 + +___ + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:67 + +___ + +### value + +• `Optional` **value**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:69 diff --git a/docs/content/references/js-client/classes/internal.AdminUpdateUserRequest.md b/docs/content/references/js-client/classes/internal.AdminUpdateUserRequest.md new file mode 100644 index 0000000000..12c727721f --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminUpdateUserRequest.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminUpdateUserRequest + +[internal](../modules/internal.md).AdminUpdateUserRequest + +## Properties + +### api\_token + +• `Optional` **api\_token**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/update-user.d.ts:32 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/update-user.d.ts:29 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/update-user.d.ts:30 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/update-user.d.ts:33 + +___ + +### role + +• `Optional` **role**: [`UserRoles`](../enums/internal.UserRoles.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/update-user.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.AdminUpsertCondition.md b/docs/content/references/js-client/classes/internal.AdminUpsertCondition.md new file mode 100644 index 0000000000..2d9c08245b --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminUpsertCondition.md @@ -0,0 +1,103 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminUpsertCondition + +[internal](../modules/internal.md).AdminUpsertCondition + +## Hierarchy + +- [`AdminUpsertConditionsReq`](internal.AdminUpsertConditionsReq.md) + + ↳ **`AdminUpsertCondition`** + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[customer_groups](internal.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:74 + +___ + +### operator + +• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:75 + +___ + +### product\_collections + +• `Optional` **product\_collections**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_collections](internal.AdminUpsertConditionsReq.md#product_collections) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:18 + +___ + +### product\_tags + +• `Optional` **product\_tags**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_tags](internal.AdminUpsertConditionsReq.md#product_tags) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:20 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_types](internal.AdminUpsertConditionsReq.md#product_types) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:19 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[products](internal.AdminUpsertConditionsReq.md#products) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:17 diff --git a/docs/content/references/js-client/classes/internal.AdminUpsertConditionsReq.md b/docs/content/references/js-client/classes/internal.AdminUpsertConditionsReq.md new file mode 100644 index 0000000000..8a1b5a7be4 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.AdminUpsertConditionsReq.md @@ -0,0 +1,69 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminUpsertConditionsReq + +[internal](../modules/internal.md).AdminUpsertConditionsReq + +## Hierarchy + +- **`AdminUpsertConditionsReq`** + + ↳ [`AdminPostDiscountsDiscountConditions`](internal.AdminPostDiscountsDiscountConditions.md) + + ↳ [`AdminPostDiscountsDiscountConditionsCondition`](internal.AdminPostDiscountsDiscountConditionsCondition.md) + + ↳ [`AdminCreateCondition`](internal.AdminCreateCondition.md) + + ↳ [`AdminUpsertCondition`](internal.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/docs/content/references/js-client/classes/internal.Axios.md b/docs/content/references/js-client/classes/internal.Axios.md new file mode 100644 index 0000000000..862690d82f --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Axios.md @@ -0,0 +1,294 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Axios + +[internal](../modules/internal.md).Axios + +## Hierarchy + +- **`Axios`** + + ↳ [`AxiosInstance`](../interfaces/internal.AxiosInstance.md) + +## Properties + +### defaults + +• **defaults**: [`AxiosDefaults`](../interfaces/internal.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.AxiosInterceptorManager.md)<[`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`any`\>\> | +| `response` | [`AxiosInterceptorManager`](../interfaces/internal.AxiosInterceptorManager.md)<[`AxiosResponse`](../interfaces/internal.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`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:179 + +___ + +### get + +▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:178 + +___ + +### getUri + +▸ **getUri**(`config?`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`any`\> | + +#### Returns + +`string` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:176 + +___ + +### head + +▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:180 + +___ + +### options + +▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:181 + +___ + +### patch + +▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `data?` | `D` | +| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:184 + +___ + +### post + +▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `data?` | `D` | +| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:182 + +___ + +### put + +▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `data?` | `D` | +| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:183 + +___ + +### request + +▸ **request**<`T`, `R`, `D`\>(`config`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:177 diff --git a/docs/content/references/js-client/classes/internal.BaseEntity.md b/docs/content/references/js-client/classes/internal.BaseEntity.md new file mode 100644 index 0000000000..ac5e39111d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.BaseEntity.md @@ -0,0 +1,69 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: BaseEntity + +[internal](../modules/internal.md).BaseEntity + +Base abstract entity for all entities + +## Hierarchy + +- **`BaseEntity`** + + ↳ [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ [`Order`](internal.Order.md) + + ↳ [`Payment`](internal.Payment.md) + + ↳ [`Fulfillment`](internal.Fulfillment.md) + + ↳ [`Return`](internal.Return.md) + + ↳ [`Refund`](internal.Refund.md) + + ↳ [`DraftOrder`](internal.DraftOrder.md) + + ↳ [`LineItem`](internal.LineItem.md) + + ↳ [`PaymentSession`](internal.PaymentSession.md) + + ↳ [`TaxRate`](internal.TaxRate.md) + + ↳ [`TaxLine`](internal.TaxLine.md) + + ↳ [`Notification`](internal.Notification.md) + + ↳ [`Store`](internal.Store.md) + +## Properties + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#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`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.Cart.md b/docs/content/references/js-client/classes/internal.Cart.md new file mode 100644 index 0000000000..a55dc23ead --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Cart.md @@ -0,0 +1,409 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Cart + +[internal](../modules/internal.md).Cart + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`Cart`** + +## Properties + +### afterLoad + +• `Private` **afterLoad**: `any` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:134 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:135 + +___ + +### billing\_address + +• **billing\_address**: [`Address`](internal.Address.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:105 + +___ + +### billing\_address\_id + +• **billing\_address\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:104 + +___ + +### completed\_at + +• **completed\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:121 + +___ + +### context + +• **context**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:124 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### customer + +• **customer**: [`Customer`](internal.Customer.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:114 + +___ + +### customer\_id + +• **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:113 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.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:127 + +___ + +### discounts + +• **discounts**: [`Discount`](internal.Discount.md)[] + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:111 + +___ + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:103 + +___ + +### gift\_card\_total + +• `Optional` **gift\_card\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:133 + +___ + +### gift\_cards + +• **gift\_cards**: [`GiftCard`](internal.GiftCard.md)[] + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:112 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.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:123 + +___ + +### items + +• **items**: [`LineItem`](internal.LineItem.md)[] + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:108 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:125 + +___ + +### object + +• `Readonly` **object**: ``"cart"`` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:102 + +___ + +### payment + +• **payment**: [`Payment`](internal.Payment.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:118 + +___ + +### payment\_authorized\_at + +• **payment\_authorized\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:122 + +___ + +### payment\_id + +• **payment\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:117 + +___ + +### payment\_session + +• **payment\_session**: ``null`` \| [`PaymentSession`](internal.PaymentSession.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:115 + +___ + +### payment\_sessions + +• **payment\_sessions**: [`PaymentSession`](internal.PaymentSession.md)[] + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:116 + +___ + +### refundable\_amount + +• `Optional` **refundable\_amount**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:132 + +___ + +### refunded\_total + +• `Optional` **refunded\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:129 + +___ + +### region + +• **region**: [`Region`](internal.Region.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:110 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:109 + +___ + +### shipping\_address + +• **shipping\_address**: ``null`` \| [`Address`](internal.Address.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:107 + +___ + +### shipping\_address\_id + +• **shipping\_address\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:106 + +___ + +### shipping\_methods + +• **shipping\_methods**: [`ShippingMethod`](internal.ShippingMethod.md)[] + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:119 + +___ + +### shipping\_total + +• `Optional` **shipping\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:126 + +___ + +### subtotal + +• `Optional` **subtotal**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:131 + +___ + +### tax\_total + +• `Optional` **tax\_total**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:128 + +___ + +### total + +• `Optional` **total**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:130 + +___ + +### type + +• **type**: [`CartType`](../enums/internal.CartType.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:120 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.ClaimImage.md b/docs/content/references/js-client/classes/internal.ClaimImage.md new file mode 100644 index 0000000000..f22cab56b6 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ClaimImage.md @@ -0,0 +1,119 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ClaimImage + +[internal](../modules/internal.md).ClaimImage + +## Hierarchy + +- [`SoftDeletableEntity`](internal.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.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.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/docs/content/references/js-client/classes/internal.ClaimItem.md b/docs/content/references/js-client/classes/internal.ClaimItem.md new file mode 100644 index 0000000000..ed2ce4e8b5 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ClaimItem.md @@ -0,0 +1,199 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ClaimItem + +[internal](../modules/internal.md).ClaimItem + +## Hierarchy + +- [`SoftDeletableEntity`](internal.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.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### images + +• **images**: [`ClaimImage`](internal.ClaimImage.md)[] + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:14 + +___ + +### item + +• **item**: [`LineItem`](internal.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.ClaimReason.md) + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:21 + +___ + +### tags + +• **tags**: [`ClaimTag`](internal.ClaimTag.md)[] + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:24 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### variant + +• **variant**: [`ProductVariant`](internal.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/docs/content/references/js-client/classes/internal.ClaimOrder.md b/docs/content/references/js-client/classes/internal.ClaimOrder.md new file mode 100644 index 0000000000..b484e9913c --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ClaimOrder.md @@ -0,0 +1,249 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ClaimOrder + +[internal](../modules/internal.md).ClaimOrder + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`ClaimOrder`** + +## Properties + +### additional\_items + +• **additional\_items**: [`LineItem`](internal.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`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:43 + +___ + +### claim\_items + +• **claim\_items**: [`ClaimItem`](internal.ClaimItem.md)[] + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:32 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Overrides + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:44 + +___ + +### deleted\_at + +• **deleted\_at**: [`Date`](../modules/internal.md#date) + +#### Overrides + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:46 + +___ + +### fulfillment\_status + +• **fulfillment\_status**: [`ClaimFulfillmentStatus`](../enums/internal.ClaimFulfillmentStatus.md) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:31 + +___ + +### fulfillments + +• **fulfillments**: [`Fulfillment`](internal.Fulfillment.md)[] + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:41 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.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.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.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.Return.md) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:37 + +___ + +### shipping\_address + +• **shipping\_address**: [`Address`](internal.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.ShippingMethod.md)[] + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:40 + +___ + +### type + +• **type**: [`ClaimType`](../enums/internal.ClaimType.md) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:34 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Overrides + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal.ClaimTag.md b/docs/content/references/js-client/classes/internal.ClaimTag.md new file mode 100644 index 0000000000..78c08ba65d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ClaimTag.md @@ -0,0 +1,99 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ClaimTag + +[internal](../modules/internal.md).ClaimTag + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`ClaimTag`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/claim-tag.d.ts:5 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.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/docs/content/references/js-client/classes/internal.Client.md b/docs/content/references/js-client/classes/internal.Client.md new file mode 100644 index 0000000000..c639553c93 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Client.md @@ -0,0 +1,186 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Client + +[internal](../modules/internal.md).Client + +## Properties + +### axiosClient + +• `Private` **axiosClient**: [`AxiosInstance`](../interfaces/internal.AxiosInstance.md) + +#### Defined in + +[packages/medusa-js/src/request.ts:29](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L29) + +___ + +### config + +• `Private` **config**: [`Config`](../interfaces/internal.Config.md) + +#### Defined in + +[packages/medusa-js/src/request.ts:30](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L30) + +## Methods + +### createClient + +▸ **createClient**(`config`): [`AxiosInstance`](../interfaces/internal.AxiosInstance.md) + +Creates the axios client used for requests +As part of the creation, we configure the retry conditions +and the exponential backoff approach. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `config` | [`Config`](../interfaces/internal.Config.md) | user supplied configurations | + +#### Returns + +[`AxiosInstance`](../interfaces/internal.AxiosInstance.md) + +#### Defined in + +[packages/medusa-js/src/request.ts:146](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L146) + +___ + +### normalizeHeader + +▸ **normalizeHeader**(`header`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `header` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/medusa-js/src/request.ts:83](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L83) + +___ + +### 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:71](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L71) + +___ + +### request + +▸ **request**(`method`, `path`, `payload?`, `options?`, `customHeaders?`): [`Promise`](../modules/internal.md#promise)<`any`\> + +Axios request + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `method` | [`RequestMethod`](../modules/internal.md#requestmethod) | `undefined` | request method | +| `path` | `string` | `undefined` | request path | +| `payload` | ``null`` \| [`Record`](../modules/internal.md#record)<`string`, `any`\> | `null` | request payload | +| `options` | [`RequestOptions`](../interfaces/internal.RequestOptions.md) | `{}` | axios configuration | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | `{}` | custom request headers | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`any`\> + +#### Defined in + +[packages/medusa-js/src/request.ts:183](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L183) + +___ + +### requiresAuthentication + +▸ **requiresAuthentication**(`path`, `method`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `any` | +| `method` | `any` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/medusa-js/src/request.ts:92](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L92) + +___ + +### setHeaders + +▸ **setHeaders**(`userHeaders`, `method`, `path`, `customHeaders?`): [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +Creates all the initial headers. +We add the idempotency key, if the request is configured to retry. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `userHeaders` | [`RequestOptions`](../interfaces/internal.RequestOptions.md) | user supplied headers | +| `method` | [`RequestMethod`](../modules/internal.md#requestmethod) | request method | +| `path` | `string` | request path | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | user supplied headers | + +#### Returns + +[`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +#### Defined in + +[packages/medusa-js/src/request.ts:108](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L108) + +___ + +### shouldRetryCondition + +▸ **shouldRetryCondition**(`err`, `numRetries`, `maxRetries`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`AxiosError`](../interfaces/internal.AxiosError.md)<`any`, `any`\> | +| `numRetries` | `number` | +| `maxRetries` | `number` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/medusa-js/src/request.ts:40](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L40) diff --git a/docs/content/references/js-client/classes/internal.Country.md b/docs/content/references/js-client/classes/internal.Country.md new file mode 100644 index 0000000000..54f223ca45 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Country.md @@ -0,0 +1,87 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Country + +[internal](../modules/internal.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.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/docs/content/references/js-client/classes/internal.Currency.md b/docs/content/references/js-client/classes/internal.Currency.md new file mode 100644 index 0000000000..7cc9bee20a --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Currency.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Currency + +[internal](../modules/internal.md).Currency + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/models/currency.d.ts:2 + +___ + +### 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/docs/content/references/js-client/classes/internal.CustomShippingOption.md b/docs/content/references/js-client/classes/internal.CustomShippingOption.md new file mode 100644 index 0000000000..b1cbdf55e9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.CustomShippingOption.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CustomShippingOption + +[internal](../modules/internal.md).CustomShippingOption + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:107 + +___ + +### price + +• **price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:108 diff --git a/docs/content/references/js-client/classes/internal.Customer.md b/docs/content/references/js-client/classes/internal.Customer.md new file mode 100644 index 0000000000..57747b599a --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Customer.md @@ -0,0 +1,199 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Customer + +[internal](../modules/internal.md).Customer + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`Customer`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:18 + +___ + +### billing\_address + +• **billing\_address**: [`Address`](internal.Address.md) + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:10 + +___ + +### billing\_address\_id + +• **billing\_address\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:9 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.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.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.SoftDeletableEntity.md).[id](internal.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.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.Address.md)[] + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:11 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.CustomerGroup.md b/docs/content/references/js-client/classes/internal.CustomerGroup.md new file mode 100644 index 0000000000..32732baa61 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.CustomerGroup.md @@ -0,0 +1,119 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CustomerGroup + +[internal](../modules/internal.md).CustomerGroup + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`CustomerGroup`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/customer-group.d.ts:9 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### customers + +• **customers**: [`Customer`](internal.Customer.md)[] + +#### Defined in + +packages/medusa/dist/models/customer-group.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +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.PriceList.md)[] + +#### Defined in + +packages/medusa/dist/models/customer-group.d.ts:7 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.CustomerGroupsBatchCustomer.md b/docs/content/references/js-client/classes/internal.CustomerGroupsBatchCustomer.md new file mode 100644 index 0000000000..3f64abb928 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.CustomerGroupsBatchCustomer.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CustomerGroupsBatchCustomer + +[internal](../modules/internal.md).CustomerGroupsBatchCustomer + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:10 diff --git a/docs/content/references/js-client/classes/internal.DateComparisonOperator.md b/docs/content/references/js-client/classes/internal.DateComparisonOperator.md new file mode 100644 index 0000000000..baa39f0110 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.DateComparisonOperator.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DateComparisonOperator + +[internal](../modules/internal.md).DateComparisonOperator + +## Properties + +### gt + +• `Optional` **gt**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:46 + +___ + +### gte + +• `Optional` **gte**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:47 + +___ + +### lt + +• `Optional` **lt**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:45 + +___ + +### lte + +• `Optional` **lte**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:48 diff --git a/docs/content/references/js-client/classes/internal.Discount.md b/docs/content/references/js-client/classes/internal.Discount.md new file mode 100644 index 0000000000..18eab4c2a5 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Discount.md @@ -0,0 +1,219 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Discount + +[internal](../modules/internal.md).Discount + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`Discount`** + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:5 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### ends\_at + +• **ends\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:13 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.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.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.Region.md)[] + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:15 + +___ + +### rule + +• **rule**: [`DiscountRule`](internal.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`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:12 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### upperCaseCode + +• `Private` **upperCaseCode**: `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/docs/content/references/js-client/classes/internal.DiscountCondition.md b/docs/content/references/js-client/classes/internal.DiscountCondition.md new file mode 100644 index 0000000000..355d626346 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.DiscountCondition.md @@ -0,0 +1,179 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DiscountCondition + +[internal](../modules/internal.md).DiscountCondition + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`DiscountCondition`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:30 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### customer\_groups + +• **customer\_groups**: [`CustomerGroup`](internal.CustomerGroup.md)[] + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:28 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### discount\_rule + +• **discount\_rule**: [`DiscountRule`](internal.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.SoftDeletableEntity.md).[id](internal.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.DiscountConditionOperator.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:21 + +___ + +### product\_collections + +• **product\_collections**: [`ProductCollection`](internal.ProductCollection.md)[] + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:27 + +___ + +### product\_tags + +• **product\_tags**: [`ProductTag`](internal.ProductTag.md)[] + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:26 + +___ + +### product\_types + +• **product\_types**: [`ProductType`](internal.ProductType.md)[] + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:25 + +___ + +### products + +• **products**: [`Product`](internal.Product.md)[] + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:24 + +___ + +### type + +• **type**: [`DiscountConditionType`](../enums/internal.DiscountConditionType.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:20 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.DiscountRule.md b/docs/content/references/js-client/classes/internal.DiscountRule.md new file mode 100644 index 0000000000..7c3e9aee75 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.DiscountRule.md @@ -0,0 +1,139 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DiscountRule + +[internal](../modules/internal.md).DiscountRule + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`DiscountRule`** + +## Properties + +### allocation + +• **allocation**: [`AllocationType`](../enums/internal.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.DiscountCondition.md)[] + +#### Defined in + +packages/medusa/dist/models/discount-rule.d.ts:17 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.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.SoftDeletableEntity.md).[id](internal.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.DiscountRuleType.md) + +#### Defined in + +packages/medusa/dist/models/discount-rule.d.ts:14 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.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/docs/content/references/js-client/classes/internal.DraftOrder.md b/docs/content/references/js-client/classes/internal.DraftOrder.md new file mode 100644 index 0000000000..d9aecbab6a --- /dev/null +++ b/docs/content/references/js-client/classes/internal.DraftOrder.md @@ -0,0 +1,175 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DraftOrder + +[internal](../modules/internal.md).DraftOrder + +## Hierarchy + +- [`BaseEntity`](internal.BaseEntity.md) + + ↳ **`DraftOrder`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:20 + +___ + +### canceled\_at + +• **canceled\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:15 + +___ + +### cart + +• **cart**: [`Cart`](internal.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`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:16 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.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.BaseEntity.md).[id](internal.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.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.DraftOrderStatus.md) + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:9 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.FilterableCustomerGroupProps.md b/docs/content/references/js-client/classes/internal.FilterableCustomerGroupProps.md new file mode 100644 index 0000000000..41bde548f8 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.FilterableCustomerGroupProps.md @@ -0,0 +1,63 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FilterableCustomerGroupProps + +[internal](../modules/internal.md).FilterableCustomerGroupProps + +## Hierarchy + +- **`FilterableCustomerGroupProps`** + + ↳ [`AdminGetCustomerGroupsParams`](internal.AdminGetCustomerGroupsParams.md) + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:7 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.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.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:6 diff --git a/docs/content/references/js-client/classes/internal.FilterablePriceListProps.md b/docs/content/references/js-client/classes/internal.FilterablePriceListProps.md new file mode 100644 index 0000000000..647cc83932 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.FilterablePriceListProps.md @@ -0,0 +1,113 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FilterablePriceListProps + +[internal](../modules/internal.md).FilterablePriceListProps + +## Hierarchy + +- **`FilterablePriceListProps`** + + ↳ [`AdminGetPriceListPaginationParams`](internal.AdminGetPriceListPaginationParams.md) + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.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.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.PriceListStatus.md)[] + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:14 + +___ + +### type + +• `Optional` **type**: [`PriceListType`](../enums/internal.PriceListType.md)[] + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:18 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:20 diff --git a/docs/content/references/js-client/classes/internal.FindParams.md b/docs/content/references/js-client/classes/internal.FindParams.md new file mode 100644 index 0000000000..dcacec0518 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.FindParams.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FindParams + +[internal](../modules/internal.md).FindParams + +## Hierarchy + +- **`FindParams`** + + ↳ [`AdminGetCustomerGroupsGroupParams`](internal.AdminGetCustomerGroupsGroupParams.md) + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:89 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:90 diff --git a/docs/content/references/js-client/classes/internal.Fulfillment.md b/docs/content/references/js-client/classes/internal.Fulfillment.md new file mode 100644 index 0000000000..a3b2468752 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Fulfillment.md @@ -0,0 +1,235 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Fulfillment + +[internal](../modules/internal.md).Fulfillment + +## Hierarchy + +- [`BaseEntity`](internal.BaseEntity.md) + + ↳ **`Fulfillment`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:26 + +___ + +### canceled\_at + +• **canceled\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:23 + +___ + +### claim\_order + +• **claim\_order**: [`ClaimOrder`](internal.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`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.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:21 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[id](internal.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:25 + +___ + +### items + +• **items**: [`FulfillmentItem`](internal.FulfillmentItem.md)[] + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:18 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:24 + +___ + +### no\_notification + +• **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:15 + +___ + +### order + +• **order**: [`Order`](internal.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.FulfillmentProvider.md) + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:17 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:16 + +___ + +### shipped\_at + +• **shipped\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:22 + +___ + +### swap + +• **swap**: [`Swap`](internal.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.TrackingLink.md)[] + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:19 + +___ + +### tracking\_numbers + +• **tracking\_numbers**: `string`[] + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:20 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.FulfillmentItem.md b/docs/content/references/js-client/classes/internal.FulfillmentItem.md new file mode 100644 index 0000000000..9df69a525a --- /dev/null +++ b/docs/content/references/js-client/classes/internal.FulfillmentItem.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FulfillmentItem + +[internal](../modules/internal.md).FulfillmentItem + +## Properties + +### fulfillment + +• **fulfillment**: [`Fulfillment`](internal.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.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/docs/content/references/js-client/classes/internal.FulfillmentOption.md b/docs/content/references/js-client/classes/internal.FulfillmentOption.md new file mode 100644 index 0000000000..c3cd8aed48 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.FulfillmentOption.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FulfillmentOption + +[internal](../modules/internal.md).FulfillmentOption + +## Properties + +### options + +• **options**: `unknown`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/index.d.ts:17 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/index.d.ts:16 diff --git a/docs/content/references/js-client/classes/internal.FulfillmentProvider.md b/docs/content/references/js-client/classes/internal.FulfillmentProvider.md new file mode 100644 index 0000000000..ce999aa913 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.FulfillmentProvider.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FulfillmentProvider + +[internal](../modules/internal.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/docs/content/references/js-client/classes/internal.GiftCard.md b/docs/content/references/js-client/classes/internal.GiftCard.md new file mode 100644 index 0000000000..8ead7e0d41 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.GiftCard.md @@ -0,0 +1,179 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: GiftCard + +[internal](../modules/internal.md).GiftCard + +## Hierarchy + +- [`SoftDeletableEntity`](internal.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:15 + +___ + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:5 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### ends\_at + +• **ends\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:13 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.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:14 + +___ + +### order + +• **order**: [`Order`](internal.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.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 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.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/docs/content/references/js-client/classes/internal.GiftCardTransaction.md b/docs/content/references/js-client/classes/internal.GiftCardTransaction.md new file mode 100644 index 0000000000..256f61455b --- /dev/null +++ b/docs/content/references/js-client/classes/internal.GiftCardTransaction.md @@ -0,0 +1,87 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: GiftCardTransaction + +[internal](../modules/internal.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:11 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/gift-card-transaction.d.ts:10 + +___ + +### gift\_card + +• **gift\_card**: [`GiftCard`](internal.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 + +___ + +### order + +• **order**: [`Order`](internal.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 diff --git a/docs/content/references/js-client/classes/internal.Group.md b/docs/content/references/js-client/classes/internal.Group.md new file mode 100644 index 0000000000..76879655e9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Group.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Group + +[internal](../modules/internal.md).Group + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:57 diff --git a/docs/content/references/js-client/classes/internal.IAdminPostUploadsFile.md b/docs/content/references/js-client/classes/internal.IAdminPostUploadsFile.md new file mode 100644 index 0000000000..53ad94c9da --- /dev/null +++ b/docs/content/references/js-client/classes/internal.IAdminPostUploadsFile.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: IAdminPostUploadsFile + +[internal](../modules/internal.md).IAdminPostUploadsFile + +## Properties + +### originalName + +• **originalName**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/uploads/create-upload.d.ts:21 + +___ + +### path + +• **path**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/uploads/create-upload.d.ts:22 diff --git a/docs/content/references/js-client/classes/internal.Image.md b/docs/content/references/js-client/classes/internal.Image.md new file mode 100644 index 0000000000..c2de0134f2 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Image.md @@ -0,0 +1,99 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Image + +[internal](../modules/internal.md).Image + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`Image`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/image.d.ts:5 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.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/docs/content/references/js-client/classes/internal.Invite.md b/docs/content/references/js-client/classes/internal.Invite.md new file mode 100644 index 0000000000..a3148ece06 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Invite.md @@ -0,0 +1,139 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Invite + +[internal](../modules/internal.md).Invite + +## Hierarchy + +- [`SoftDeletableEntity`](internal.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### expires\_at + +• **expires\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/invite.d.ts:8 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.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.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.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/docs/content/references/js-client/classes/internal.Item.md b/docs/content/references/js-client/classes/internal.Item.md new file mode 100644 index 0000000000..edab2096a2 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Item.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Item + +[internal](../modules/internal.md).Item + +## Properties + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:53 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:54 diff --git a/docs/content/references/js-client/classes/internal.LineItem.md b/docs/content/references/js-client/classes/internal.LineItem.md new file mode 100644 index 0000000000..fbfbd01b86 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.LineItem.md @@ -0,0 +1,335 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: LineItem + +[internal](../modules/internal.md).LineItem + +## Hierarchy + +- [`BaseEntity`](internal.BaseEntity.md) + + ↳ **`LineItem`** + +## Properties + +### adjustments + +• **adjustments**: [`LineItemAdjustment`](internal.LineItemAdjustment.md)[] + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:19 + +___ + +### allow\_discounts + +• **allow\_discounts**: `boolean` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:26 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:37 + +___ + +### cart + +• **cart**: [`Cart`](internal.Cart.md) + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:11 + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:10 + +___ + +### claim\_order + +• **claim\_order**: [`ClaimOrder`](internal.ClaimOrder.md) + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:17 + +___ + +### claim\_order\_id + +• **claim\_order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:16 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.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/line-item.d.ts:21 + +___ + +### fulfilled\_quantity + +• **fulfilled\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:32 + +___ + +### has\_shipping + +• **has\_shipping**: `boolean` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:27 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### is\_giftcard + +• **is\_giftcard**: `boolean` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:24 + +___ + +### is\_return + +• **is\_return**: `boolean` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:23 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:35 + +___ + +### order + +• **order**: [`Order`](internal.Order.md) + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:13 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:12 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:31 + +___ + +### refundable + +• **refundable**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:36 + +___ + +### returned\_quantity + +• **returned\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:33 + +___ + +### shipped\_quantity + +• **shipped\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:34 + +___ + +### should\_merge + +• **should\_merge**: `boolean` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:25 + +___ + +### swap + +• **swap**: [`Swap`](internal.Swap.md) + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:15 + +___ + +### swap\_id + +• **swap\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:14 + +___ + +### tax\_lines + +• **tax\_lines**: [`LineItemTaxLine`](internal.LineItemTaxLine.md)[] + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:18 + +___ + +### thumbnail + +• **thumbnail**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:22 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:20 + +___ + +### unit\_price + +• **unit\_price**: `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:28 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### variant + +• **variant**: [`ProductVariant`](internal.ProductVariant.md) + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:30 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:29 diff --git a/docs/content/references/js-client/classes/internal.LineItemAdjustment.md b/docs/content/references/js-client/classes/internal.LineItemAdjustment.md new file mode 100644 index 0000000000..e4256ccd57 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.LineItemAdjustment.md @@ -0,0 +1,97 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: LineItemAdjustment + +[internal](../modules/internal.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.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.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/docs/content/references/js-client/classes/internal.LineItemTaxLine.md b/docs/content/references/js-client/classes/internal.LineItemTaxLine.md new file mode 100644 index 0000000000..362531d4db --- /dev/null +++ b/docs/content/references/js-client/classes/internal.LineItemTaxLine.md @@ -0,0 +1,141 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: LineItemTaxLine + +[internal](../modules/internal.md).LineItemTaxLine + +## Hierarchy + +- [`TaxLine`](internal.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.TaxLine.md).[code](internal.TaxLine.md#code) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:5 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[TaxLine](internal.TaxLine.md).[created_at](internal.TaxLine.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[TaxLine](internal.TaxLine.md).[id](internal.TaxLine.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### item + +• **item**: [`LineItem`](internal.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.TaxLine.md).[metadata](internal.TaxLine.md#metadata) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:6 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[TaxLine](internal.TaxLine.md).[name](internal.TaxLine.md#name) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:4 + +___ + +### rate + +• **rate**: `number` + +#### Inherited from + +[TaxLine](internal.TaxLine.md).[rate](internal.TaxLine.md#rate) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:3 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[TaxLine](internal.TaxLine.md).[updated_at](internal.TaxLine.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.MoneyAmount.md b/docs/content/references/js-client/classes/internal.MoneyAmount.md new file mode 100644 index 0000000000..e53dd977e1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.MoneyAmount.md @@ -0,0 +1,189 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: MoneyAmount + +[internal](../modules/internal.md).MoneyAmount + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`MoneyAmount`** + +## Properties + +### 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:18 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### currency + +• **currency**: [`Currency`](internal.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +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.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 + +• **region**: [`Region`](internal.Region.md) + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:17 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:16 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### variant + +• **variant**: [`ProductVariant`](internal.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:14 diff --git a/docs/content/references/js-client/classes/internal.Note.md b/docs/content/references/js-client/classes/internal.Note.md new file mode 100644 index 0000000000..df76c91f4d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Note.md @@ -0,0 +1,139 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Note + +[internal](../modules/internal.md).Note + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`Note`** + +## Properties + +### author + +• **author**: [`User`](internal.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.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/docs/content/references/js-client/classes/internal.Notification.md b/docs/content/references/js-client/classes/internal.Notification.md new file mode 100644 index 0000000000..b64252e1e1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Notification.md @@ -0,0 +1,185 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Notification + +[internal](../modules/internal.md).Notification + +## Hierarchy + +- [`BaseEntity`](internal.BaseEntity.md) + + ↳ **`Notification`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:17 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### customer + +• **customer**: [`Customer`](internal.Customer.md) + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:9 + +___ + +### customer\_id + +• **customer\_id**: `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.BaseEntity.md).[id](internal.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.Notification.md) + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:13 + +___ + +### provider + +• **provider**: [`NotificationProvider`](internal.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.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`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.NotificationProvider.md b/docs/content/references/js-client/classes/internal.NotificationProvider.md new file mode 100644 index 0000000000..174b8384aa --- /dev/null +++ b/docs/content/references/js-client/classes/internal.NotificationProvider.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: NotificationProvider + +[internal](../modules/internal.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/docs/content/references/js-client/classes/internal.NumericalComparisonOperator.md b/docs/content/references/js-client/classes/internal.NumericalComparisonOperator.md new file mode 100644 index 0000000000..61518cf608 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.NumericalComparisonOperator.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: NumericalComparisonOperator + +[internal](../modules/internal.md).NumericalComparisonOperator + +## Properties + +### gt + +• `Optional` **gt**: `number` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:58 + +___ + +### gte + +• `Optional` **gte**: `number` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:59 + +___ + +### lt + +• `Optional` **lt**: `number` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:57 + +___ + +### lte + +• `Optional` **lte**: `number` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:60 diff --git a/docs/content/references/js-client/classes/internal.OptionRequirement.md b/docs/content/references/js-client/classes/internal.OptionRequirement.md new file mode 100644 index 0000000000..7ec23ae4c1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.OptionRequirement.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: OptionRequirement + +[internal](../modules/internal.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/docs/content/references/js-client/classes/internal.Order.md b/docs/content/references/js-client/classes/internal.Order.md new file mode 100644 index 0000000000..09bb769f00 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Order.md @@ -0,0 +1,525 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Order + +[internal](../modules/internal.md).Order + +## Hierarchy + +- [`BaseEntity`](internal.BaseEntity.md) + + ↳ **`Order`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:93 + +___ + +### billing\_address + +• **billing\_address**: [`Address`](internal.Address.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:58 + +___ + +### billing\_address\_id + +• **billing\_address\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:57 + +___ + +### canceled\_at + +• **canceled\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:79 + +___ + +### cart + +• **cart**: [`Cart`](internal.Cart.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:53 + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:52 + +___ + +### claims + +• **claims**: [`ClaimOrder`](internal.ClaimOrder.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:72 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### currency + +• **currency**: [`Currency`](internal.Currency.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:64 + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:63 + +___ + +### customer + +• **customer**: [`Customer`](internal.Customer.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:55 + +___ + +### customer\_id + +• **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:54 + +___ + +### discount\_total + +• **discount\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:85 + +___ + +### discounts + +• **discounts**: [`Discount`](internal.Discount.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:66 + +___ + +### display\_id + +• **display\_id**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:51 + +___ + +### draft\_order + +• **draft\_order**: [`DraftOrder`](internal.DraftOrder.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:76 + +___ + +### draft\_order\_id + +• **draft\_order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:75 + +___ + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:56 + +___ + +### external\_id + +• **external\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:83 + +___ + +### fulfillment\_status + +• **fulfillment\_status**: [`FulfillmentStatus`](../enums/internal.FulfillmentStatus.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:49 + +___ + +### fulfillments + +• **fulfillments**: [`Fulfillment`](internal.Fulfillment.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:70 + +___ + +### gift\_card\_total + +• **gift\_card\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:92 + +___ + +### gift\_card\_transactions + +• **gift\_card\_transactions**: [`GiftCardTransaction`](internal.GiftCardTransaction.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:78 + +___ + +### gift\_cards + +• **gift\_cards**: [`GiftCard`](internal.GiftCard.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:67 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[id](internal.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:82 + +___ + +### items + +• **items**: [`LineItem`](internal.LineItem.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:77 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/order.d.ts:80 + +___ + +### no\_notification + +• **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:81 + +___ + +### object + +• `Readonly` **object**: ``"order"`` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:47 + +___ + +### paid\_total + +• **paid\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:90 + +___ + +### payment\_status + +• **payment\_status**: [`PaymentStatus`](../enums/internal.PaymentStatus.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:50 + +___ + +### payments + +• **payments**: [`Payment`](internal.Payment.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:69 + +___ + +### refundable\_amount + +• **refundable\_amount**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:91 + +___ + +### refunded\_total + +• **refunded\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:87 + +___ + +### refunds + +• **refunds**: [`Refund`](internal.Refund.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:73 + +___ + +### region + +• **region**: [`Region`](internal.Region.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:62 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:61 + +___ + +### returns + +• **returns**: [`Return`](internal.Return.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:71 + +___ + +### shipping\_address + +• **shipping\_address**: [`Address`](internal.Address.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:60 + +___ + +### shipping\_address\_id + +• **shipping\_address\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:59 + +___ + +### shipping\_methods + +• **shipping\_methods**: [`ShippingMethod`](internal.ShippingMethod.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:68 + +___ + +### shipping\_total + +• **shipping\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:84 + +___ + +### status + +• **status**: [`OrderStatus`](../enums/internal.OrderStatus.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:48 + +___ + +### subtotal + +• **subtotal**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:89 + +___ + +### swaps + +• **swaps**: [`Swap`](internal.Swap.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:74 + +___ + +### tax\_rate + +• **tax\_rate**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:65 + +___ + +### tax\_total + +• **tax\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:86 + +___ + +### total + +• **total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:88 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.OrdersReturnItem.md b/docs/content/references/js-client/classes/internal.OrdersReturnItem.md new file mode 100644 index 0000000000..f6b8bc77a4 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.OrdersReturnItem.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: OrdersReturnItem + +[internal](../modules/internal.md).OrdersReturnItem + +## Properties + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:22 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:25 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:23 + +___ + +### reason\_id + +• `Optional` **reason\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.Payment.md b/docs/content/references/js-client/classes/internal.Payment.md new file mode 100644 index 0000000000..68eccfb319 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Payment.md @@ -0,0 +1,225 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Payment + +[internal](../modules/internal.md).Payment + +## Hierarchy + +- [`BaseEntity`](internal.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**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:20 + +___ + +### captured\_at + +• **captured\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:19 + +___ + +### cart + +• **cart**: [`Cart`](internal.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`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### currency + +• **currency**: [`Currency`](internal.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.BaseEntity.md).[id](internal.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.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.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`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.PaymentMethod.md b/docs/content/references/js-client/classes/internal.PaymentMethod.md new file mode 100644 index 0000000000..4c7ff89d97 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.PaymentMethod.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PaymentMethod + +[internal](../modules/internal.md).PaymentMethod + +## Properties + +### data + +• `Optional` **data**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:115 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:114 diff --git a/docs/content/references/js-client/classes/internal.PaymentProvider.md b/docs/content/references/js-client/classes/internal.PaymentProvider.md new file mode 100644 index 0000000000..3bc820d86a --- /dev/null +++ b/docs/content/references/js-client/classes/internal.PaymentProvider.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PaymentProvider + +[internal](../modules/internal.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/docs/content/references/js-client/classes/internal.PaymentSession.md b/docs/content/references/js-client/classes/internal.PaymentSession.md new file mode 100644 index 0000000000..ac4f453bda --- /dev/null +++ b/docs/content/references/js-client/classes/internal.PaymentSession.md @@ -0,0 +1,135 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PaymentSession + +[internal](../modules/internal.md).PaymentSession + +## Hierarchy + +- [`BaseEntity`](internal.BaseEntity.md) + + ↳ **`PaymentSession`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:18 + +___ + +### cart + +• **cart**: [`Cart`](internal.Cart.md) + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:12 + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:11 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.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:16 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[id](internal.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:17 + +___ + +### is\_selected + +• **is\_selected**: ``null`` \| `boolean` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:14 + +___ + +### 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:15 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.PriceList.md b/docs/content/references/js-client/classes/internal.PriceList.md new file mode 100644 index 0000000000..d54f3acd24 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.PriceList.md @@ -0,0 +1,159 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PriceList + +[internal](../modules/internal.md).PriceList + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`PriceList`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:14 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### customer\_groups + +• **customer\_groups**: [`CustomerGroup`](internal.CustomerGroup.md)[] + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:12 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.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`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:11 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:6 + +___ + +### prices + +• **prices**: [`MoneyAmount`](internal.MoneyAmount.md)[] + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:13 + +___ + +### starts\_at + +• **starts\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:10 + +___ + +### status + +• **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md) + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:9 + +___ + +### type + +• **type**: [`PriceListType`](../enums/internal.PriceListType.md) + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:8 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.PriceSelectionParams.md b/docs/content/references/js-client/classes/internal.PriceSelectionParams.md new file mode 100644 index 0000000000..48b3ce2aa2 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.PriceSelectionParams.md @@ -0,0 +1,45 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PriceSelectionParams + +[internal](../modules/internal.md).PriceSelectionParams + +## Hierarchy + +- **`PriceSelectionParams`** + + ↳ [`StoreGetVariantsParams`](internal.StoreGetVariantsParams.md) + + ↳ [`StoreGetProductsPaginationParams`](internal.StoreGetProductsPaginationParams.md) + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:2 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:4 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal.Product.md b/docs/content/references/js-client/classes/internal.Product.md new file mode 100644 index 0000000000..1515b912ca --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Product.md @@ -0,0 +1,359 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Product + +[internal](../modules/internal.md).Product + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`Product`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:44 + +___ + +### collection + +• **collection**: [`ProductCollection`](internal.ProductCollection.md) + +#### Defined in + +packages/medusa/dist/models/product.d.ts:37 + +___ + +### collection\_id + +• **collection\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:36 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.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/product.d.ts:18 + +___ + +### discountable + +• **discountable**: `boolean` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:41 + +___ + +### external\_id + +• **external\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:42 + +___ + +### handle + +• **handle**: `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:19 + +___ + +### height + +• **height**: `number` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:30 + +___ + +### hs\_code + +• **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:32 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### images + +• **images**: [`Image`](internal.Image.md)[] + +#### Defined in + +packages/medusa/dist/models/product.d.ts:22 + +___ + +### is\_giftcard + +• **is\_giftcard**: `boolean` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:20 + +___ + +### length + +• **length**: `number` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:29 + +___ + +### material + +• **material**: `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:35 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/product.d.ts:43 + +___ + +### mid\_code + +• **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:34 + +___ + +### options + +• **options**: [`ProductOption`](internal.ProductOption.md)[] + +#### Defined in + +packages/medusa/dist/models/product.d.ts:24 + +___ + +### origin\_country + +• **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:33 + +___ + +### profile + +• **profile**: [`ShippingProfile`](internal.ShippingProfile.md) + +#### Defined in + +packages/medusa/dist/models/product.d.ts:27 + +___ + +### profile\_id + +• **profile\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:26 + +___ + +### status + +• **status**: [`Status`](../enums/internal.Status.md) + +#### Defined in + +packages/medusa/dist/models/product.d.ts:21 + +___ + +### subtitle + +• **subtitle**: `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:17 + +___ + +### tags + +• **tags**: [`ProductTag`](internal.ProductTag.md)[] + +#### Defined in + +packages/medusa/dist/models/product.d.ts:40 + +___ + +### thumbnail + +• **thumbnail**: `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:23 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:16 + +___ + +### type + +• **type**: [`ProductType`](internal.ProductType.md) + +#### Defined in + +packages/medusa/dist/models/product.d.ts:39 + +___ + +### type\_id + +• **type\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:38 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### variants + +• **variants**: [`ProductVariant`](internal.ProductVariant.md)[] + +#### Defined in + +packages/medusa/dist/models/product.d.ts:25 + +___ + +### weight + +• **weight**: `number` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:28 + +___ + +### width + +• **width**: `number` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.ProductCollection.md b/docs/content/references/js-client/classes/internal.ProductCollection.md new file mode 100644 index 0000000000..b046d1523d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ProductCollection.md @@ -0,0 +1,119 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductCollection + +[internal](../modules/internal.md).ProductCollection + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`ProductCollection`** + +## Properties + +### createHandleIfNotProvided + +• `Private` **createHandleIfNotProvided**: `any` + +#### Defined in + +packages/medusa/dist/models/product-collection.d.ts:8 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.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.SoftDeletableEntity.md).[id](internal.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.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.ProductOption.md b/docs/content/references/js-client/classes/internal.ProductOption.md new file mode 100644 index 0000000000..212ddada62 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ProductOption.md @@ -0,0 +1,129 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductOption + +[internal](../modules/internal.md).ProductOption + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`ProductOption`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product-option.d.ts:10 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +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.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### values + +• **values**: [`ProductOptionValue`](internal.ProductOptionValue.md)[] + +#### Defined in + +packages/medusa/dist/models/product-option.d.ts:6 diff --git a/docs/content/references/js-client/classes/internal.ProductOptionReq.md b/docs/content/references/js-client/classes/internal.ProductOptionReq.md new file mode 100644 index 0000000000..61b8715749 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ProductOptionReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductOptionReq + +[internal](../modules/internal.md).ProductOptionReq + +## Properties + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:204 diff --git a/docs/content/references/js-client/classes/internal.ProductOptionValue.md b/docs/content/references/js-client/classes/internal.ProductOptionValue.md new file mode 100644 index 0000000000..acd474ae15 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ProductOptionValue.md @@ -0,0 +1,139 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductOptionValue + +[internal](../modules/internal.md).ProductOptionValue + +## Hierarchy + +- [`SoftDeletableEntity`](internal.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +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.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.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.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/docs/content/references/js-client/classes/internal.ProductTag.md b/docs/content/references/js-client/classes/internal.ProductTag.md new file mode 100644 index 0000000000..2dacc3e2fe --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ProductTag.md @@ -0,0 +1,99 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductTag + +[internal](../modules/internal.md).ProductTag + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`ProductTag`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product-tag.d.ts:5 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.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/docs/content/references/js-client/classes/internal.ProductTagReq.md b/docs/content/references/js-client/classes/internal.ProductTagReq.md new file mode 100644 index 0000000000..22d10c2a5c --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ProductTagReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductTagReq + +[internal](../modules/internal.md).ProductTagReq + +## Properties + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:197 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:198 diff --git a/docs/content/references/js-client/classes/internal.ProductType.md b/docs/content/references/js-client/classes/internal.ProductType.md new file mode 100644 index 0000000000..9c71b0a730 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ProductType.md @@ -0,0 +1,99 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductType + +[internal](../modules/internal.md).ProductType + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`ProductType`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product-type.d.ts:5 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.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/docs/content/references/js-client/classes/internal.ProductTypeReq.md b/docs/content/references/js-client/classes/internal.ProductTypeReq.md new file mode 100644 index 0000000000..d0b986722c --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ProductTypeReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductTypeReq + +[internal](../modules/internal.md).ProductTypeReq + +## Properties + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:193 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:194 diff --git a/docs/content/references/js-client/classes/internal.ProductVariant.md b/docs/content/references/js-client/classes/internal.ProductVariant.md new file mode 100644 index 0000000000..4172fcd60b --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ProductVariant.md @@ -0,0 +1,299 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariant + +[internal](../modules/internal.md).ProductVariant + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`ProductVariant`** + +## Properties + +### allow\_backorder + +• **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:16 + +___ + +### barcode + +• **barcode**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:11 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:28 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.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:12 + +___ + +### height + +• **height**: `number` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:24 + +___ + +### hs\_code + +• **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:18 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### inventory\_quantity + +• **inventory\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:15 + +___ + +### length + +• **length**: `number` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:23 + +___ + +### manage\_inventory + +• **manage\_inventory**: `boolean` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:17 + +___ + +### material + +• **material**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:21 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:27 + +___ + +### mid\_code + +• **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:20 + +___ + +### options + +• **options**: [`ProductOptionValue`](internal.ProductOptionValue.md)[] + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:26 + +___ + +### origin\_country + +• **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:19 + +___ + +### prices + +• **prices**: [`MoneyAmount`](internal.MoneyAmount.md)[] + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:9 + +___ + +### product + +• **product**: [`Product`](internal.Product.md) + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:8 + +___ + +### product\_id + +• **product\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:7 + +___ + +### sku + +• **sku**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:10 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:6 + +___ + +### upc + +• **upc**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:13 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.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:14 + +___ + +### weight + +• **weight**: `number` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:22 + +___ + +### width + +• **width**: `number` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.ProductVariantOptionReq.md b/docs/content/references/js-client/classes/internal.ProductVariantOptionReq.md new file mode 100644 index 0000000000..ab336554f7 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ProductVariantOptionReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantOptionReq + +[internal](../modules/internal.md).ProductVariantOptionReq + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:115 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:114 diff --git a/docs/content/references/js-client/classes/internal.ProductVariantPricesCreateReq.md b/docs/content/references/js-client/classes/internal.ProductVariantPricesCreateReq.md new file mode 100644 index 0000000000..c21b827ca0 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ProductVariantPricesCreateReq.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantPricesCreateReq + +[internal](../modules/internal.md).ProductVariantPricesCreateReq + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:99 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:98 + +___ + +### max\_quantity + +• `Optional` **max\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:101 + +___ + +### min\_quantity + +• `Optional` **min\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:100 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:97 diff --git a/docs/content/references/js-client/classes/internal.ProductVariantPricesUpdateReq.md b/docs/content/references/js-client/classes/internal.ProductVariantPricesUpdateReq.md new file mode 100644 index 0000000000..e472835463 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ProductVariantPricesUpdateReq.md @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantPricesUpdateReq + +[internal](../modules/internal.md).ProductVariantPricesUpdateReq + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:92 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:91 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:89 + +___ + +### max\_quantity + +• `Optional` **max\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:94 + +___ + +### min\_quantity + +• `Optional` **min\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:93 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:90 diff --git a/docs/content/references/js-client/classes/internal.ProductVariantReq.md b/docs/content/references/js-client/classes/internal.ProductVariantReq.md new file mode 100644 index 0000000000..13c68c7b86 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ProductVariantReq.md @@ -0,0 +1,197 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantReq + +[internal](../modules/internal.md).ProductVariantReq + +## Properties + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:214 + +___ + +### barcode + +• `Optional` **barcode**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:211 + +___ + +### ean + +• `Optional` **ean**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:209 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:218 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:212 + +___ + +### inventory\_quantity + +• **inventory\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:213 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:217 + +___ + +### manage\_inventory + +• `Optional` **manage\_inventory**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:215 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:222 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:223 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:221 + +___ + +### options + +• `Optional` **options**: `ProductVariantOptionReq`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:225 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:220 + +___ + +### prices + +• **prices**: [`ProductVariantPricesCreateReq`](internal.ProductVariantPricesCreateReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:224 + +___ + +### sku + +• `Optional` **sku**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:208 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:207 + +___ + +### upc + +• `Optional` **upc**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:210 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:216 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:219 diff --git a/docs/content/references/js-client/classes/internal.Refund.md b/docs/content/references/js-client/classes/internal.Refund.md new file mode 100644 index 0000000000..682fc16ec7 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Refund.md @@ -0,0 +1,135 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Refund + +[internal](../modules/internal.md).Refund + +## Hierarchy + +- [`BaseEntity`](internal.BaseEntity.md) + + ↳ **`Refund`** + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:13 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:18 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:17 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:16 + +___ + +### note + +• **note**: `string` + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:14 + +___ + +### order + +• **order**: [`Order`](internal.Order.md) + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:12 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:11 + +___ + +### reason + +• **reason**: `string` + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:15 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.Region.md b/docs/content/references/js-client/classes/internal.Region.md new file mode 100644 index 0000000000..46b534b951 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Region.md @@ -0,0 +1,219 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Region + +[internal](../modules/internal.md).Region + +## Hierarchy + +- [`SoftDeletableEntity`](internal.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:23 + +___ + +### countries + +• **countries**: [`Country`](internal.Country.md)[] + +#### Defined in + +packages/medusa/dist/models/region.d.ts:17 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### currency + +• **currency**: [`Currency`](internal.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### fulfillment\_providers + +• **fulfillment\_providers**: [`FulfillmentProvider`](internal.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.SoftDeletableEntity.md).[id](internal.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/region.d.ts:22 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/models/region.d.ts:9 + +___ + +### payment\_providers + +• **payment\_providers**: [`PaymentProvider`](internal.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.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.TaxRate.md)[] + +#### Defined in + +packages/medusa/dist/models/region.d.ts:13 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.Return.md b/docs/content/references/js-client/classes/internal.Return.md new file mode 100644 index 0000000000..071eed7c26 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Return.md @@ -0,0 +1,215 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Return + +[internal](../modules/internal.md).Return + +## Hierarchy + +- [`BaseEntity`](internal.BaseEntity.md) + + ↳ **`Return`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:29 + +___ + +### claim\_order + +• **claim\_order**: [`ClaimOrder`](internal.ClaimOrder.md) + +#### Defined in + +packages/medusa/dist/models/return.d.ts:19 + +___ + +### claim\_order\_id + +• **claim\_order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:18 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:28 + +___ + +### items + +• **items**: [`ReturnItem`](internal.ReturnItem.md)[] + +#### Defined in + +packages/medusa/dist/models/return.d.ts:15 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/return.d.ts:27 + +___ + +### no\_notification + +• **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:26 + +___ + +### order + +• **order**: [`Order`](internal.Order.md) + +#### Defined in + +packages/medusa/dist/models/return.d.ts:21 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:20 + +___ + +### received\_at + +• **received\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/return.d.ts:25 + +___ + +### refund\_amount + +• **refund\_amount**: `number` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:24 + +___ + +### shipping\_data + +• **shipping\_data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/return.d.ts:23 + +___ + +### shipping\_method + +• **shipping\_method**: [`ShippingMethod`](internal.ShippingMethod.md) + +#### Defined in + +packages/medusa/dist/models/return.d.ts:22 + +___ + +### status + +• **status**: [`ReturnStatus`](../enums/internal.ReturnStatus.md) + +#### Defined in + +packages/medusa/dist/models/return.d.ts:14 + +___ + +### swap + +• **swap**: [`Swap`](internal.Swap.md) + +#### Defined in + +packages/medusa/dist/models/return.d.ts:17 + +___ + +### swap\_id + +• **swap\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:16 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.ReturnItem.md b/docs/content/references/js-client/classes/internal.ReturnItem.md new file mode 100644 index 0000000000..8588d39d8c --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ReturnItem.md @@ -0,0 +1,127 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ReturnItem + +[internal](../modules/internal.md).ReturnItem + +## Properties + +### is\_requested + +• **is\_requested**: `boolean` + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:10 + +___ + +### item + +• **item**: [`LineItem`](internal.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.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.Return.md) + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.ReturnReason.md b/docs/content/references/js-client/classes/internal.ReturnReason.md new file mode 100644 index 0000000000..e0234428a0 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ReturnReason.md @@ -0,0 +1,149 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ReturnReason + +[internal](../modules/internal.md).ReturnReason + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`ReturnReason`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/return-reason.d.ts:10 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.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.SoftDeletableEntity.md).[id](internal.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**: [`ReturnReason`](internal.ReturnReason.md) + +#### Defined in + +packages/medusa/dist/models/return-reason.d.ts:7 + +___ + +### parent\_return\_reason\_id + +• **parent\_return\_reason\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/return-reason.d.ts:6 + +___ + +### return\_reason\_children + +• **return\_reason\_children**: [`ReturnReason`](internal.ReturnReason.md)[] + +#### Defined in + +packages/medusa/dist/models/return-reason.d.ts:8 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.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/docs/content/references/js-client/classes/internal.ReturnShipping.md b/docs/content/references/js-client/classes/internal.ReturnShipping.md new file mode 100644 index 0000000000..ada78d7b6d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ReturnShipping.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ReturnShipping + +[internal](../modules/internal.md).ReturnShipping + +## Properties + +### option\_id + +• `Optional` **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:76 + +___ + +### price + +• `Optional` **price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:77 diff --git a/docs/content/references/js-client/classes/internal.ShippingAddressPayload.md b/docs/content/references/js-client/classes/internal.ShippingAddressPayload.md new file mode 100644 index 0000000000..251849179a --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ShippingAddressPayload.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingAddressPayload + +[internal](../modules/internal.md).ShippingAddressPayload + +## Properties + +### postal\_code + +• `Optional` **postal\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.ShippingMethod.md b/docs/content/references/js-client/classes/internal.ShippingMethod.md new file mode 100644 index 0000000000..a3a60380b4 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ShippingMethod.md @@ -0,0 +1,177 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingMethod + +[internal](../modules/internal.md).ShippingMethod + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:25 + +___ + +### cart + +• **cart**: [`Cart`](internal.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.ClaimOrder.md) + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:14 + +___ + +### claim\_order\_id + +• **claim\_order\_id**: `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 + +___ + +### order + +• **order**: [`Order`](internal.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.Return.md) + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:20 + +___ + +### shipping\_option + +• **shipping\_option**: [`ShippingOption`](internal.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 + +___ + +### swap + +• **swap**: [`Swap`](internal.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.ShippingMethodTaxLine.md)[] + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:22 diff --git a/docs/content/references/js-client/classes/internal.ShippingMethodTaxLine.md b/docs/content/references/js-client/classes/internal.ShippingMethodTaxLine.md new file mode 100644 index 0000000000..5bfe653556 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ShippingMethodTaxLine.md @@ -0,0 +1,141 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingMethodTaxLine + +[internal](../modules/internal.md).ShippingMethodTaxLine + +## Hierarchy + +- [`TaxLine`](internal.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.TaxLine.md).[code](internal.TaxLine.md#code) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:5 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[TaxLine](internal.TaxLine.md).[created_at](internal.TaxLine.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[TaxLine](internal.TaxLine.md).[id](internal.TaxLine.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TaxLine](internal.TaxLine.md).[metadata](internal.TaxLine.md#metadata) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:6 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[TaxLine](internal.TaxLine.md).[name](internal.TaxLine.md#name) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:4 + +___ + +### rate + +• **rate**: `number` + +#### Inherited from + +[TaxLine](internal.TaxLine.md).[rate](internal.TaxLine.md#rate) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:3 + +___ + +### shipping\_method + +• **shipping\_method**: [`ShippingMethod`](internal.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`](../modules/internal.md#date) + +#### Inherited from + +[TaxLine](internal.TaxLine.md).[updated_at](internal.TaxLine.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.ShippingOption.md b/docs/content/references/js-client/classes/internal.ShippingOption.md new file mode 100644 index 0000000000..cd44e0fc49 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ShippingOption.md @@ -0,0 +1,219 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingOption + +[internal](../modules/internal.md).ShippingOption + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`ShippingOption`** + +## Properties + +### admin\_only + +• **admin\_only**: `boolean` + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:21 + +___ + +### amount + +• **amount**: `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:25 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### 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.ShippingOptionPriceType.md) + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:18 + +___ + +### profile + +• **profile**: [`ShippingProfile`](internal.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.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.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.ShippingOptionRequirement.md)[] + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:22 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.ShippingOptionRequirement.md b/docs/content/references/js-client/classes/internal.ShippingOptionRequirement.md new file mode 100644 index 0000000000..575ce8871b --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ShippingOptionRequirement.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingOptionRequirement + +[internal](../modules/internal.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`](../modules/internal.md#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.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.RequirementType.md) + +#### Defined in + +packages/medusa/dist/models/shipping-option-requirement.d.ts:10 diff --git a/docs/content/references/js-client/classes/internal.ShippingProfile.md b/docs/content/references/js-client/classes/internal.ShippingProfile.md new file mode 100644 index 0000000000..e75b180fdc --- /dev/null +++ b/docs/content/references/js-client/classes/internal.ShippingProfile.md @@ -0,0 +1,129 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingProfile + +[internal](../modules/internal.md).ShippingProfile + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`ShippingProfile`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/shipping-profile.d.ts:15 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +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.Product.md)[] + +#### Defined in + +packages/medusa/dist/models/shipping-profile.d.ts:12 + +___ + +### shipping\_options + +• **shipping\_options**: [`ShippingOption`](internal.ShippingOption.md)[] + +#### Defined in + +packages/medusa/dist/models/shipping-profile.d.ts:13 + +___ + +### type + +• **type**: [`ShippingProfileType`](../enums/internal.ShippingProfileType.md) + +#### Defined in + +packages/medusa/dist/models/shipping-profile.d.ts:11 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md b/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md new file mode 100644 index 0000000000..a62437ea5b --- /dev/null +++ b/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md @@ -0,0 +1,127 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: SoftDeletableEntity + +[internal](../modules/internal.md).SoftDeletableEntity + +## Hierarchy + +- [`BaseEntity`](internal.BaseEntity.md) + + ↳ **`SoftDeletableEntity`** + + ↳↳ [`Customer`](internal.Customer.md) + + ↳↳ [`Address`](internal.Address.md) + + ↳↳ [`CustomerGroup`](internal.CustomerGroup.md) + + ↳↳ [`Cart`](internal.Cart.md) + + ↳↳ [`Region`](internal.Region.md) + + ↳↳ [`Discount`](internal.Discount.md) + + ↳↳ [`GiftCard`](internal.GiftCard.md) + + ↳↳ [`ClaimOrder`](internal.ClaimOrder.md) + + ↳↳ [`Swap`](internal.Swap.md) + + ↳↳ [`PriceList`](internal.PriceList.md) + + ↳↳ [`DiscountRule`](internal.DiscountRule.md) + + ↳↳ [`ShippingOption`](internal.ShippingOption.md) + + ↳↳ [`TrackingLink`](internal.TrackingLink.md) + + ↳↳ [`ClaimItem`](internal.ClaimItem.md) + + ↳↳ [`ProductVariant`](internal.ProductVariant.md) + + ↳↳ [`MoneyAmount`](internal.MoneyAmount.md) + + ↳↳ [`Product`](internal.Product.md) + + ↳↳ [`ProductType`](internal.ProductType.md) + + ↳↳ [`DiscountCondition`](internal.DiscountCondition.md) + + ↳↳ [`ShippingProfile`](internal.ShippingProfile.md) + + ↳↳ [`ReturnReason`](internal.ReturnReason.md) + + ↳↳ [`ClaimImage`](internal.ClaimImage.md) + + ↳↳ [`ClaimTag`](internal.ClaimTag.md) + + ↳↳ [`ProductOptionValue`](internal.ProductOptionValue.md) + + ↳↳ [`Image`](internal.Image.md) + + ↳↳ [`ProductOption`](internal.ProductOption.md) + + ↳↳ [`ProductCollection`](internal.ProductCollection.md) + + ↳↳ [`ProductTag`](internal.ProductTag.md) + + ↳↳ [`User`](internal.User.md) + + ↳↳ [`Invite`](internal.Invite.md) + + ↳↳ [`Note`](internal.Note.md) + +## Properties + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.Store.md b/docs/content/references/js-client/classes/internal.Store.md new file mode 100644 index 0000000000..2255b3bf0b --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Store.md @@ -0,0 +1,145 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Store + +[internal](../modules/internal.md).Store + +## Hierarchy + +- [`BaseEntity`](internal.BaseEntity.md) + + ↳ **`Store`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:12 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### currencies + +• **currencies**: [`Currency`](internal.Currency.md)[] + +#### Defined in + +packages/medusa/dist/models/store.d.ts:7 + +___ + +### default\_currency + +• **default\_currency**: [`Currency`](internal.Currency.md) + +#### Defined in + +packages/medusa/dist/models/store.d.ts:6 + +___ + +### default\_currency\_code + +• **default\_currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:5 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### invite\_link\_template + +• **invite\_link\_template**: `string` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:10 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/store.d.ts:11 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:4 + +___ + +### payment\_link\_template + +• **payment\_link\_template**: `string` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:9 + +___ + +### swap\_link\_template + +• **swap\_link\_template**: `string` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:8 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.StoreGetCollectionsParams.md b/docs/content/references/js-client/classes/internal.StoreGetCollectionsParams.md new file mode 100644 index 0000000000..a36e12ac50 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StoreGetCollectionsParams.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetCollectionsParams + +[internal](../modules/internal.md).StoreGetCollectionsParams + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:27 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:25 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:26 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.StoreGetCustomersCustomerOrdersParams.md b/docs/content/references/js-client/classes/internal.StoreGetCustomersCustomerOrdersParams.md new file mode 100644 index 0000000000..31b538ee07 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StoreGetCustomersCustomerOrdersParams.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetCustomersCustomerOrdersParams + +[internal](../modules/internal.md).StoreGetCustomersCustomerOrdersParams + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:41 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:40 + +___ + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:38 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal.StoreGetOrdersParams.md b/docs/content/references/js-client/classes/internal.StoreGetOrdersParams.md new file mode 100644 index 0000000000..3587786270 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StoreGetOrdersParams.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetOrdersParams + +[internal](../modules/internal.md).StoreGetOrdersParams + +## Properties + +### display\_id + +• **display\_id**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts:27 + +___ + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts:28 + +___ + +### shipping\_address + +• `Optional` **shipping\_address**: [`ShippingAddressPayload`](internal.ShippingAddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts:29 diff --git a/docs/content/references/js-client/classes/internal.StoreGetProductsPaginationParams.md b/docs/content/references/js-client/classes/internal.StoreGetProductsPaginationParams.md new file mode 100644 index 0000000000..8a29e3ace4 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StoreGetProductsPaginationParams.md @@ -0,0 +1,97 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetProductsPaginationParams + +[internal](../modules/internal.md).StoreGetProductsPaginationParams + +## Hierarchy + +- [`PriceSelectionParams`](internal.PriceSelectionParams.md) + + ↳ **`StoreGetProductsPaginationParams`** + + ↳↳ [`StoreGetProductsParams`](internal.StoreGetProductsParams.md) + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal.PriceSelectionParams.md).[cart_id](internal.PriceSelectionParams.md#cart_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:2 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[PriceSelectionParams](internal.PriceSelectionParams.md).[currency_code](internal.PriceSelectionParams.md#currency_code) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:4 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:50 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:49 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:52 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:51 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal.PriceSelectionParams.md).[region_id](internal.PriceSelectionParams.md#region_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal.StoreGetProductsParams.md b/docs/content/references/js-client/classes/internal.StoreGetProductsParams.md new file mode 100644 index 0000000000..9693f1e0b9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StoreGetProductsParams.md @@ -0,0 +1,221 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetProductsParams + +[internal](../modules/internal.md).StoreGetProductsParams + +## Hierarchy + +- [`StoreGetProductsPaginationParams`](internal.StoreGetProductsPaginationParams.md) + + ↳ **`StoreGetProductsParams`** + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[cart_id](internal.StoreGetProductsPaginationParams.md#cart_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:2 + +___ + +### collection\_id + +• `Optional` **collection\_id**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:57 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:64 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[currency_code](internal.StoreGetProductsPaginationParams.md#currency_code) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:4 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:60 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[expand](internal.StoreGetProductsPaginationParams.md#expand) + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:50 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[fields](internal.StoreGetProductsPaginationParams.md#fields) + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:49 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:61 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:55 + +___ + +### is\_giftcard + +• `Optional` **is\_giftcard**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:62 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[limit](internal.StoreGetProductsPaginationParams.md#limit) + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:52 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[offset](internal.StoreGetProductsPaginationParams.md#offset) + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:51 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:56 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[region_id](internal.StoreGetProductsPaginationParams.md#region_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:3 + +___ + +### tags + +• `Optional` **tags**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:58 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:59 + +___ + +### type + +• `Optional` **type**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:63 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:65 diff --git a/docs/content/references/js-client/classes/internal.StoreGetShippingOptionsParams.md b/docs/content/references/js-client/classes/internal.StoreGetShippingOptionsParams.md new file mode 100644 index 0000000000..4b11df922d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StoreGetShippingOptionsParams.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetShippingOptionsParams + +[internal](../modules/internal.md).StoreGetShippingOptionsParams + +## Properties + +### is\_return + +• `Optional` **is\_return**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/shipping-options/list-options.d.ts:29 + +___ + +### product\_ids + +• `Optional` **product\_ids**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/shipping-options/list-options.d.ts:27 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/shipping-options/list-options.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.StoreGetVariantsParams.md b/docs/content/references/js-client/classes/internal.StoreGetVariantsParams.md new file mode 100644 index 0000000000..5b82cdc339 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StoreGetVariantsParams.md @@ -0,0 +1,125 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetVariantsParams + +[internal](../modules/internal.md).StoreGetVariantsParams + +## Hierarchy + +- [`PriceSelectionParams`](internal.PriceSelectionParams.md) + + ↳ **`StoreGetVariantsParams`** + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal.PriceSelectionParams.md).[cart_id](internal.PriceSelectionParams.md#cart_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:2 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[PriceSelectionParams](internal.PriceSelectionParams.md).[currency_code](internal.PriceSelectionParams.md#currency_code) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:4 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:32 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:34 + +___ + +### ids + +• `Optional` **ids**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:33 + +___ + +### inventory\_quantity + +• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:36 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:30 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:31 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal.PriceSelectionParams.md).[region_id](internal.PriceSelectionParams.md#region_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:3 + +___ + +### title + +• `Optional` **title**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:35 diff --git a/docs/content/references/js-client/classes/internal.StorePostAuthReq.md b/docs/content/references/js-client/classes/internal.StorePostAuthReq.md new file mode 100644 index 0000000000..b8df1236c5 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostAuthReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostAuthReq + +[internal](../modules/internal.md).StorePostAuthReq + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/auth/create-session.d.ts:24 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/auth/create-session.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartReq.md b/docs/content/references/js-client/classes/internal.StorePostCartReq.md new file mode 100644 index 0000000000..aad768f916 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostCartReq.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartReq + +[internal](../modules/internal.md).StorePostCartReq + +## Properties + +### context + +• `Optional` **context**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:56 + +___ + +### country\_code + +• `Optional` **country\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:54 + +___ + +### items + +• `Optional` **items**: `Item`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:55 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:53 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsItemReq.md b/docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsItemReq.md new file mode 100644 index 0000000000..3f3cb5c944 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsItemReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartsCartLineItemsItemReq + +[internal](../modules/internal.md).StorePostCartsCartLineItemsItemReq + +## Properties + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-line-item.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsReq.md b/docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsReq.md new file mode 100644 index 0000000000..071b556989 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsReq.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartsCartLineItemsReq + +[internal](../modules/internal.md).StorePostCartsCartLineItemsReq + +## Properties + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-line-item.d.ts:29 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-line-item.d.ts:28 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-line-item.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionReq.md b/docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionReq.md new file mode 100644 index 0000000000..18edea0240 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartsCartPaymentSessionReq + +[internal](../modules/internal.md).StorePostCartsCartPaymentSessionReq + +## Properties + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/set-payment-session.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionUpdateReq.md b/docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionUpdateReq.md new file mode 100644 index 0000000000..9785ca8da9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionUpdateReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartsCartPaymentSessionUpdateReq + +[internal](../modules/internal.md).StorePostCartsCartPaymentSessionUpdateReq + +## Properties + +### data + +• **data**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-payment-session.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartsCartReq.md b/docs/content/references/js-client/classes/internal.StorePostCartsCartReq.md new file mode 100644 index 0000000000..35f7d4e19f --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostCartsCartReq.md @@ -0,0 +1,97 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartsCartReq + +[internal](../modules/internal.md).StorePostCartsCartReq + +## Properties + +### billing\_address + +• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:81 + +___ + +### context + +• `Optional` **context**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:86 + +___ + +### country\_code + +• `Optional` **country\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:79 + +___ + +### customer\_id + +• `Optional` **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:85 + +___ + +### discounts + +• `Optional` **discounts**: `Discount`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:84 + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:80 + +___ + +### gift\_cards + +• `Optional` **gift\_cards**: `GiftCard`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:83 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:78 + +___ + +### shipping\_address + +• `Optional` **shipping\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:82 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartsCartShippingMethodReq.md b/docs/content/references/js-client/classes/internal.StorePostCartsCartShippingMethodReq.md new file mode 100644 index 0000000000..08f676cc2e --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostCartsCartShippingMethodReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartsCartShippingMethodReq + +[internal](../modules/internal.md).StorePostCartsCartShippingMethodReq + +## 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:26 + +___ + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/add-shipping-method.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md new file mode 100644 index 0000000000..50cda4f84d --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md @@ -0,0 +1,167 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCustomersCustomerAddressesAddressReq + +[internal](../modules/internal.md).StorePostCustomersCustomerAddressesAddressReq + +## 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:68 + +___ + +### 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:69 + +___ + +### city + +• `Optional` **city**: `string` + +#### Inherited from + +[AddressPayload](internal.AddressPayload.md).[city](internal.AddressPayload.md#city) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:70 + +___ + +### company + +• `Optional` **company**: `string` + +#### Inherited from + +[AddressPayload](internal.AddressPayload.md).[company](internal.AddressPayload.md#company) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:67 + +___ + +### 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:71 + +___ + +### 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:63 + +___ + +### 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:64 + +___ + +### 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:66 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Inherited from + +[AddressPayload](internal.AddressPayload.md).[phone](internal.AddressPayload.md#phone) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:65 + +___ + +### 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:73 + +___ + +### province + +• `Optional` **province**: `string` + +#### Inherited from + +[AddressPayload](internal.AddressPayload.md).[province](internal.AddressPayload.md#province) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:72 diff --git a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md new file mode 100644 index 0000000000..5118e0ced8 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCustomersCustomerAddressesReq + +[internal](../modules/internal.md).StorePostCustomersCustomerAddressesReq + +## Properties + +### address + +• **address**: [`AddressCreatePayload`](internal.AddressCreatePayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/create-address.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerPasswordTokenReq.md b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerPasswordTokenReq.md new file mode 100644 index 0000000000..b8ff317a6b --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerPasswordTokenReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCustomersCustomerPasswordTokenReq + +[internal](../modules/internal.md).StorePostCustomersCustomerPasswordTokenReq + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/reset-password-token.d.ts:17 diff --git a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerReq.md b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerReq.md new file mode 100644 index 0000000000..4914cc2c10 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerReq.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCustomersCustomerReq + +[internal](../modules/internal.md).StorePostCustomersCustomerReq + +## Properties + +### billing\_address + +• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:50 + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:55 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:51 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:52 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:56 + +___ + +### password + +• `Optional` **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:53 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:54 diff --git a/docs/content/references/js-client/classes/internal.StorePostCustomersReq.md b/docs/content/references/js-client/classes/internal.StorePostCustomersReq.md new file mode 100644 index 0000000000..74c71715f6 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostCustomersReq.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCustomersReq + +[internal](../modules/internal.md).StorePostCustomersReq + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:29 + +___ + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:27 + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:28 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:30 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.StorePostReturnsReq.md b/docs/content/references/js-client/classes/internal.StorePostReturnsReq.md new file mode 100644 index 0000000000..76a9720865 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostReturnsReq.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostReturnsReq + +[internal](../modules/internal.md).StorePostReturnsReq + +## Properties + +### items + +• **items**: `Item`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/returns/create-return.d.ts:65 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/returns/create-return.d.ts:64 + +___ + +### return\_shipping + +• `Optional` **return\_shipping**: `ReturnShipping` + +#### Defined in + +packages/medusa/dist/api/routes/store/returns/create-return.d.ts:66 diff --git a/docs/content/references/js-client/classes/internal.StorePostSearchReq.md b/docs/content/references/js-client/classes/internal.StorePostSearchReq.md new file mode 100644 index 0000000000..10393fae3a --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostSearchReq.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostSearchReq + +[internal](../modules/internal.md).StorePostSearchReq + +## Properties + +### filter + +• `Optional` **filter**: `unknown` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/search.d.ts:7 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/search.d.ts:6 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/search.d.ts:5 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/search.d.ts:4 diff --git a/docs/content/references/js-client/classes/internal.StorePostSwapsReq.md b/docs/content/references/js-client/classes/internal.StorePostSwapsReq.md new file mode 100644 index 0000000000..9b98ae0243 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StorePostSwapsReq.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostSwapsReq + +[internal](../modules/internal.md).StorePostSwapsReq + +## Properties + +### additional\_items + +• **additional\_items**: `AdditionalItem`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:86 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:84 + +___ + +### return\_items + +• **return\_items**: `Item`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:85 + +___ + +### return\_shipping\_option + +• `Optional` **return\_shipping\_option**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:87 diff --git a/docs/content/references/js-client/classes/internal.StringComparisonOperator.md b/docs/content/references/js-client/classes/internal.StringComparisonOperator.md new file mode 100644 index 0000000000..a6d01a398a --- /dev/null +++ b/docs/content/references/js-client/classes/internal.StringComparisonOperator.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StringComparisonOperator + +[internal](../modules/internal.md).StringComparisonOperator + +## Properties + +### gt + +• `Optional` **gt**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:52 + +___ + +### gte + +• `Optional` **gte**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:53 + +___ + +### lt + +• `Optional` **lt**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:51 + +___ + +### lte + +• `Optional` **lte**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:54 diff --git a/docs/content/references/js-client/classes/internal.Swap.md b/docs/content/references/js-client/classes/internal.Swap.md new file mode 100644 index 0000000000..318733f6d3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.Swap.md @@ -0,0 +1,279 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Swap + +[internal](../modules/internal.md).Swap + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`Swap`** + +## Properties + +### additional\_items + +• **additional\_items**: [`LineItem`](internal.LineItem.md)[] + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:33 + +___ + +### allow\_backorder + +• **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:46 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:49 + +___ + +### canceled\_at + +• **canceled\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:44 + +___ + +### cart + +• **cart**: [`Cart`](internal.Cart.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:42 + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:41 + +___ + +### confirmed\_at + +• **confirmed\_at**: [`Date`](../modules/internal.md#date) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:43 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.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:37 + +___ + +### fulfillment\_status + +• **fulfillment\_status**: [`SwapFulfillmentStatus`](../enums/internal.SwapFulfillmentStatus.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:29 + +___ + +### fulfillments + +• **fulfillments**: [`Fulfillment`](internal.Fulfillment.md)[] + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:35 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.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:47 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:48 + +___ + +### no\_notification + +• **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:45 + +___ + +### order + +• **order**: [`Order`](internal.Order.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:32 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:31 + +___ + +### payment + +• **payment**: [`Payment`](internal.Payment.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:36 + +___ + +### payment\_status + +• **payment\_status**: [`SwapPaymentStatus`](../enums/internal.SwapPaymentStatus.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:30 + +___ + +### return\_order + +• **return\_order**: [`Return`](internal.Return.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:34 + +___ + +### shipping\_address + +• **shipping\_address**: [`Address`](internal.Address.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:39 + +___ + +### shipping\_address\_id + +• **shipping\_address\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:38 + +___ + +### shipping\_methods + +• **shipping\_methods**: [`ShippingMethod`](internal.ShippingMethod.md)[] + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:40 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.TaxLine.md b/docs/content/references/js-client/classes/internal.TaxLine.md new file mode 100644 index 0000000000..1e9143dc29 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.TaxLine.md @@ -0,0 +1,99 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: TaxLine + +[internal](../modules/internal.md).TaxLine + +## Hierarchy + +- [`BaseEntity`](internal.BaseEntity.md) + + ↳ **`TaxLine`** + + ↳↳ [`ShippingMethodTaxLine`](internal.ShippingMethodTaxLine.md) + + ↳↳ [`LineItemTaxLine`](internal.LineItemTaxLine.md) + +## Properties + +### code + +• **code**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:5 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) + +#### Defined in + +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`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.TaxProvider.md b/docs/content/references/js-client/classes/internal.TaxProvider.md new file mode 100644 index 0000000000..e7465bc2a6 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.TaxProvider.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: TaxProvider + +[internal](../modules/internal.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/docs/content/references/js-client/classes/internal.TaxRate.md b/docs/content/references/js-client/classes/internal.TaxRate.md new file mode 100644 index 0000000000..ccdc419491 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.TaxRate.md @@ -0,0 +1,185 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: TaxRate + +[internal](../modules/internal.md).TaxRate + +## Hierarchy + +- [`BaseEntity`](internal.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`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) + +#### Defined in + +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.ProductType.md)[] + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:14 + +___ + +### products + +• **products**: [`Product`](internal.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.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.ShippingOption.md)[] + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:15 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.TrackingLink.md b/docs/content/references/js-client/classes/internal.TrackingLink.md new file mode 100644 index 0000000000..f49d299e05 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.TrackingLink.md @@ -0,0 +1,139 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: TrackingLink + +[internal](../modules/internal.md).TrackingLink + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`TrackingLink`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/tracking-link.d.ts:10 + +___ + +### created\_at + +• **created\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### fulfillment + +• **fulfillment**: [`Fulfillment`](internal.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.SoftDeletableEntity.md).[id](internal.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.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/docs/content/references/js-client/classes/internal.User.md b/docs/content/references/js-client/classes/internal.User.md new file mode 100644 index 0000000000..3f4add48b3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.User.md @@ -0,0 +1,149 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: User + +[internal](../modules/internal.md).User + +## Hierarchy + +- [`SoftDeletableEntity`](internal.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`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.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.SoftDeletableEntity.md).[id](internal.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.UserRoles.md) + +#### Defined in + +packages/medusa/dist/models/user.d.ts:8 + +___ + +### updated\_at + +• **updated\_at**: [`Date`](../modules/internal.md#date) + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/enums/internal.AllocationType.md b/docs/content/references/js-client/enums/internal.AllocationType.md new file mode 100644 index 0000000000..3503425431 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.AllocationType.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: AllocationType + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.CartType.md b/docs/content/references/js-client/enums/internal.CartType.md new file mode 100644 index 0000000000..a9a5c6cdf6 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.CartType.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: CartType + +[internal](../modules/internal.md).CartType + +## Enumeration members + +### CLAIM + +• **CLAIM** = `"claim"` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:99 + +___ + +### DEFAULT + +• **DEFAULT** = `"default"` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:95 + +___ + +### DRAFT\_ORDER + +• **DRAFT\_ORDER** = `"draft_order"` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:97 + +___ + +### PAYMENT\_LINK + +• **PAYMENT\_LINK** = `"payment_link"` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:98 + +___ + +### SWAP + +• **SWAP** = `"swap"` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:96 diff --git a/docs/content/references/js-client/enums/internal.ClaimFulfillmentStatus.md b/docs/content/references/js-client/enums/internal.ClaimFulfillmentStatus.md new file mode 100644 index 0000000000..a6c87962f9 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.ClaimFulfillmentStatus.md @@ -0,0 +1,97 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: ClaimFulfillmentStatus + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.ClaimPaymentStatus.md b/docs/content/references/js-client/enums/internal.ClaimPaymentStatus.md new file mode 100644 index 0000000000..b090dac64e --- /dev/null +++ b/docs/content/references/js-client/enums/internal.ClaimPaymentStatus.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: ClaimPaymentStatus + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.ClaimReason.md b/docs/content/references/js-client/enums/internal.ClaimReason.md new file mode 100644 index 0000000000..0fc127902e --- /dev/null +++ b/docs/content/references/js-client/enums/internal.ClaimReason.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: ClaimReason + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.ClaimType.md b/docs/content/references/js-client/enums/internal.ClaimType.md new file mode 100644 index 0000000000..a6cefd9bc6 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.ClaimType.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: ClaimType + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.DiscountConditionOperator.md b/docs/content/references/js-client/enums/internal.DiscountConditionOperator.md new file mode 100644 index 0000000000..1c5202356b --- /dev/null +++ b/docs/content/references/js-client/enums/internal.DiscountConditionOperator.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: DiscountConditionOperator + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.DiscountConditionType.md b/docs/content/references/js-client/enums/internal.DiscountConditionType.md new file mode 100644 index 0000000000..49cac5445c --- /dev/null +++ b/docs/content/references/js-client/enums/internal.DiscountConditionType.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: DiscountConditionType + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.DiscountRuleType.md b/docs/content/references/js-client/enums/internal.DiscountRuleType.md new file mode 100644 index 0000000000..95c5cace82 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.DiscountRuleType.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: DiscountRuleType + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.DraftOrderStatus.md b/docs/content/references/js-client/enums/internal.DraftOrderStatus.md new file mode 100644 index 0000000000..b0f25d4b05 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.DraftOrderStatus.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: DraftOrderStatus + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.FulfillmentStatus.md b/docs/content/references/js-client/enums/internal.FulfillmentStatus.md new file mode 100644 index 0000000000..cc82a79d0b --- /dev/null +++ b/docs/content/references/js-client/enums/internal.FulfillmentStatus.md @@ -0,0 +1,97 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: FulfillmentStatus + +[internal](../modules/internal.md).FulfillmentStatus + +## Enumeration members + +### CANCELED + +• **CANCELED** = `"canceled"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:34 + +___ + +### FULFILLED + +• **FULFILLED** = `"fulfilled"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:29 + +___ + +### NOT\_FULFILLED + +• **NOT\_FULFILLED** = `"not_fulfilled"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:27 + +___ + +### PARTIALLY\_FULFILLED + +• **PARTIALLY\_FULFILLED** = `"partially_fulfilled"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:28 + +___ + +### PARTIALLY\_RETURNED + +• **PARTIALLY\_RETURNED** = `"partially_returned"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:32 + +___ + +### PARTIALLY\_SHIPPED + +• **PARTIALLY\_SHIPPED** = `"partially_shipped"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:30 + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = `"requires_action"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:35 + +___ + +### RETURNED + +• **RETURNED** = `"returned"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:33 + +___ + +### SHIPPED + +• **SHIPPED** = `"shipped"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:31 diff --git a/docs/content/references/js-client/enums/internal.OrderStatus.md b/docs/content/references/js-client/enums/internal.OrderStatus.md new file mode 100644 index 0000000000..55ab50baa3 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.OrderStatus.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: OrderStatus + +[internal](../modules/internal.md).OrderStatus + +## Enumeration members + +### ARCHIVED + +• **ARCHIVED** = `"archived"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:22 + +___ + +### CANCELED + +• **CANCELED** = `"canceled"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:23 + +___ + +### COMPLETED + +• **COMPLETED** = `"completed"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:21 + +___ + +### PENDING + +• **PENDING** = `"pending"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:20 + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = `"requires_action"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:24 diff --git a/docs/content/references/js-client/enums/internal.PaymentStatus.md b/docs/content/references/js-client/enums/internal.PaymentStatus.md new file mode 100644 index 0000000000..40260dff5e --- /dev/null +++ b/docs/content/references/js-client/enums/internal.PaymentStatus.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: PaymentStatus + +[internal](../modules/internal.md).PaymentStatus + +## Enumeration members + +### AWAITING + +• **AWAITING** = `"awaiting"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:39 + +___ + +### CANCELED + +• **CANCELED** = `"canceled"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:43 + +___ + +### CAPTURED + +• **CAPTURED** = `"captured"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:40 + +___ + +### NOT\_PAID + +• **NOT\_PAID** = `"not_paid"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:38 + +___ + +### PARTIALLY\_REFUNDED + +• **PARTIALLY\_REFUNDED** = `"partially_refunded"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:41 + +___ + +### REFUNDED + +• **REFUNDED** = `"refunded"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:42 + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = `"requires_action"` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:44 diff --git a/docs/content/references/js-client/enums/internal.PriceListStatus.md b/docs/content/references/js-client/enums/internal.PriceListStatus.md new file mode 100644 index 0000000000..edbbadb4b5 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.PriceListStatus.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: PriceListStatus + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.PriceListType.md b/docs/content/references/js-client/enums/internal.PriceListType.md new file mode 100644 index 0000000000..3d50b0fdc3 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.PriceListType.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: PriceListType + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.ProductStatus.md b/docs/content/references/js-client/enums/internal.ProductStatus.md new file mode 100644 index 0000000000..414e4c7681 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.ProductStatus.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: ProductStatus + +[internal](../modules/internal.md).ProductStatus + +## Enumeration members + +### DRAFT + +• **DRAFT** = `"draft"` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:54 + +___ + +### PROPOSED + +• **PROPOSED** = `"proposed"` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:55 + +___ + +### PUBLISHED + +• **PUBLISHED** = `"published"` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:56 + +___ + +### REJECTED + +• **REJECTED** = `"rejected"` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:57 diff --git a/docs/content/references/js-client/enums/internal.RequirementType.md b/docs/content/references/js-client/enums/internal.RequirementType.md new file mode 100644 index 0000000000..3afc6df8ab --- /dev/null +++ b/docs/content/references/js-client/enums/internal.RequirementType.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: RequirementType + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.ReturnStatus.md b/docs/content/references/js-client/enums/internal.ReturnStatus.md new file mode 100644 index 0000000000..3e46681fe3 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.ReturnStatus.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: ReturnStatus + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.ShippingOptionPriceType.md b/docs/content/references/js-client/enums/internal.ShippingOptionPriceType.md new file mode 100644 index 0000000000..2c3694c4b6 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.ShippingOptionPriceType.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: ShippingOptionPriceType + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.ShippingProfileType.md b/docs/content/references/js-client/enums/internal.ShippingProfileType.md new file mode 100644 index 0000000000..5ff5818600 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.ShippingProfileType.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: ShippingProfileType + +[internal](../modules/internal.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/docs/content/references/js-client/enums/internal.Status.md b/docs/content/references/js-client/enums/internal.Status.md new file mode 100644 index 0000000000..ed474bf2ee --- /dev/null +++ b/docs/content/references/js-client/enums/internal.Status.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: Status + +[internal](../modules/internal.md).Status + +## Enumeration members + +### DRAFT + +• **DRAFT** = `"draft"` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:10 + +___ + +### PROPOSED + +• **PROPOSED** = `"proposed"` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:11 + +___ + +### PUBLISHED + +• **PUBLISHED** = `"published"` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:12 + +___ + +### REJECTED + +• **REJECTED** = `"rejected"` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:13 diff --git a/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md b/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md new file mode 100644 index 0000000000..b0ef31f55f --- /dev/null +++ b/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: SwapFulfillmentStatus + +[internal](../modules/internal.md).SwapFulfillmentStatus + +## Enumeration members + +### CANCELED + +• **CANCELED** = `"canceled"` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:14 + +___ + +### 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 + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = `"requires_action"` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:15 + +___ + +### SHIPPED + +• **SHIPPED** = `"shipped"` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:13 diff --git a/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md b/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md new file mode 100644 index 0000000000..9485189c78 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md @@ -0,0 +1,97 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: SwapPaymentStatus + +[internal](../modules/internal.md).SwapPaymentStatus + +## Enumeration members + +### AWAITING + +• **AWAITING** = `"awaiting"` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:19 + +___ + +### CANCELED + +• **CANCELED** = `"canceled"` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:22 + +___ + +### CAPTURED + +• **CAPTURED** = `"captured"` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:20 + +___ + +### CONFIRMED + +• **CONFIRMED** = `"confirmed"` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:21 + +___ + +### DIFFERENCE\_REFUNDED + +• **DIFFERENCE\_REFUNDED** = `"difference_refunded"` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:23 + +___ + +### NOT\_PAID + +• **NOT\_PAID** = `"not_paid"` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:18 + +___ + +### PARTIALLY\_REFUNDED + +• **PARTIALLY\_REFUNDED** = `"partially_refunded"` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:24 + +___ + +### REFUNDED + +• **REFUNDED** = `"refunded"` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:25 + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = `"requires_action"` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:26 diff --git a/docs/content/references/js-client/enums/internal.UserRoles.md b/docs/content/references/js-client/enums/internal.UserRoles.md new file mode 100644 index 0000000000..fdad68f0e8 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.UserRoles.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: UserRoles + +[internal](../modules/internal.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/docs/content/references/js-client/index.md b/docs/content/references/js-client/index.md new file mode 100644 index 0000000000..2d56c916ad --- /dev/null +++ b/docs/content/references/js-client/index.md @@ -0,0 +1,92 @@ +# JS Client Reference + +## Namespaces + +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) +- [internal](modules/internal.md) + +## Classes + +- [AddressesResource](classes/AddressesResource.md) +- [Admin](classes/Admin.md) +- [AdminAuthResource](classes/AdminAuthResource.md) +- [AdminCollectionsResource](classes/AdminCollectionsResource.md) +- [AdminCustomerGroupsResource](classes/AdminCustomerGroupsResource.md) +- [AdminCustomersResource](classes/AdminCustomersResource.md) +- [AdminDiscountsResource](classes/AdminDiscountsResource.md) +- [AdminDraftOrdersResource](classes/AdminDraftOrdersResource.md) +- [AdminGiftCardsResource](classes/AdminGiftCardsResource.md) +- [AdminInvitesResource](classes/AdminInvitesResource.md) +- [AdminNotesResource](classes/AdminNotesResource.md) +- [AdminNotificationsResource](classes/AdminNotificationsResource.md) +- [AdminOrdersResource](classes/AdminOrdersResource.md) +- [AdminPriceListResource](classes/AdminPriceListResource.md) +- [AdminProductTagsResource](classes/AdminProductTagsResource.md) +- [AdminProductTypesResource](classes/AdminProductTypesResource.md) +- [AdminProductsResource](classes/AdminProductsResource.md) +- [AdminRegionsResource](classes/AdminRegionsResource.md) +- [AdminReturnReasonsResource](classes/AdminReturnReasonsResource.md) +- [AdminReturnsResource](classes/AdminReturnsResource.md) +- [AdminShippingOptionsResource](classes/AdminShippingOptionsResource.md) +- [AdminShippingProfilesResource](classes/AdminShippingProfilesResource.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) +- [OrdersResource](classes/OrdersResource.md) +- [PaymentMethodsResource](classes/PaymentMethodsResource.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) diff --git a/docs/content/references/js-client/interfaces/internal.AbortSignal.md b/docs/content/references/js-client/interfaces/internal.AbortSignal.md new file mode 100644 index 0000000000..6e039d7b4e --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.AbortSignal.md @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AbortSignal + +[internal](../modules/internal.md).AbortSignal + +A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object. + +## Properties + +### aborted + +• `Readonly` **aborted**: `boolean` + +Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise. + +#### Defined in + +node_modules/@types/node/globals.d.ts:64 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosAdapter.md b/docs/content/references/js-client/interfaces/internal.AxiosAdapter.md new file mode 100644 index 0000000000..862239771e --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.AxiosAdapter.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosAdapter + +[internal](../modules/internal.md).AxiosAdapter + +## Callable + +### AxiosAdapter + +▸ **AxiosAdapter**(`config`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> | + +#### Returns + +[`AxiosPromise`](internal.AxiosPromise.md)<`any`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:18 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosBasicCredentials.md b/docs/content/references/js-client/interfaces/internal.AxiosBasicCredentials.md new file mode 100644 index 0000000000..ae9075abb3 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.AxiosBasicCredentials.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosBasicCredentials + +[internal](../modules/internal.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/docs/content/references/js-client/interfaces/internal.AxiosDefaults.md b/docs/content/references/js-client/interfaces/internal.AxiosDefaults.md new file mode 100644 index 0000000000..e5abadab97 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.AxiosDefaults.md @@ -0,0 +1,507 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosDefaults + +[internal](../modules/internal.md).AxiosDefaults + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `D` | `any` | + +## Hierarchy + +- [`Omit`](../modules/internal.md#omit)<[`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\>, ``"headers"``\> + + ↳ **`AxiosDefaults`** + +## Properties + +### adapter + +• `Optional` **adapter**: [`AxiosAdapter`](internal.AxiosAdapter.md) + +#### Inherited from + +Omit.adapter + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:75 + +___ + +### auth + +• `Optional` **auth**: [`AxiosBasicCredentials`](internal.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.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.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.md#method) + +#### Inherited from + +Omit.method + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:64 + +___ + +### params + +• `Optional` **params**: `any` + +#### Inherited from + +Omit.params + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:69 + +___ + +### proxy + +• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](internal.AxiosProxyConfig.md) + +#### Inherited from + +Omit.proxy + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:89 + +___ + +### raxConfig + +• `Optional` **raxConfig**: [`RetryConfig`](internal.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.md#responsetype) + +#### Inherited from + +Omit.responseType + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:77 + +___ + +### signal + +• `Optional` **signal**: [`AbortSignal`](../modules/internal.md#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.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md)[] + +#### Inherited from + +Omit.transformRequest + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:66 + +___ + +### transformResponse + +• `Optional` **transformResponse**: [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md)[] + +#### Inherited from + +Omit.transformResponse + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:67 + +___ + +### transitional + +• `Optional` **transitional**: [`TransitionalOptions`](internal.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 + +## Methods + +### onDownloadProgress + +▸ `Optional` **onDownloadProgress**(`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`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `progressEvent` | `any` | + +#### Returns + +`void` + +#### Inherited from + +Omit.onUploadProgress + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:80 + +___ + +### paramsSerializer + +▸ `Optional` **paramsSerializer**(`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 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosError.md b/docs/content/references/js-client/interfaces/internal.AxiosError.md new file mode 100644 index 0000000000..7513419e68 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.AxiosError.md @@ -0,0 +1,126 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosError + +[internal](../modules/internal.md).AxiosError + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `D` | `any` | + +## Hierarchy + +- [`Error`](../modules/internal.md#error) + + ↳ **`AxiosError`** + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:126 + +___ + +### config + +• **config**: [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`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 + +node_modules/typescript/lib/lib.es5.d.ts:1023 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1022 + +___ + +### request + +• `Optional` **request**: `any` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:127 + +___ + +### response + +• `Optional` **response**: [`AxiosResponse`](internal.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 + +node_modules/typescript/lib/lib.es5.d.ts:1024 + +## Methods + +### toJSON + +▸ **toJSON**(): `object` + +#### Returns + +`object` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:130 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosInstance.md b/docs/content/references/js-client/interfaces/internal.AxiosInstance.md new file mode 100644 index 0000000000..e9c6af1fba --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.AxiosInstance.md @@ -0,0 +1,377 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosInstance + +[internal](../modules/internal.md).AxiosInstance + +## Hierarchy + +- [`Axios`](../classes/internal.Axios.md) + + ↳ **`AxiosInstance`** + +## Callable + +### AxiosInstance + +▸ **AxiosInstance**(`config`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> | + +#### Returns + +[`AxiosPromise`](internal.AxiosPromise.md)<`any`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:188 + +### AxiosInstance + +▸ **AxiosInstance**(`url`, `config?`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> | + +#### Returns + +[`AxiosPromise`](internal.AxiosPromise.md)<`any`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:189 + +## Properties + +### defaults + +• **defaults**: [`AxiosDefaults`](internal.AxiosDefaults.md)<`any`\> + +#### Inherited from + +[Axios](../classes/internal.Axios.md).[defaults](../classes/internal.Axios.md#defaults) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:171 + +___ + +### interceptors + +• **interceptors**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `request` | [`AxiosInterceptorManager`](internal.AxiosInterceptorManager.md)<[`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\>\> | +| `response` | [`AxiosInterceptorManager`](internal.AxiosInterceptorManager.md)<[`AxiosResponse`](internal.AxiosResponse.md)<`any`, `any`\>\> | + +#### Inherited from + +[Axios](../classes/internal.Axios.md).[interceptors](../classes/internal.Axios.md#interceptors) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:172 + +## Methods + +### delete + +▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Inherited from + +[Axios](../classes/internal.Axios.md).[delete](../classes/internal.Axios.md#delete) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:179 + +___ + +### get + +▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Inherited from + +[Axios](../classes/internal.Axios.md).[get](../classes/internal.Axios.md#get) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:178 + +___ + +### getUri + +▸ **getUri**(`config?`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> | + +#### Returns + +`string` + +#### Inherited from + +[Axios](../classes/internal.Axios.md).[getUri](../classes/internal.Axios.md#geturi) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:176 + +___ + +### head + +▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Inherited from + +[Axios](../classes/internal.Axios.md).[head](../classes/internal.Axios.md#head) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:180 + +___ + +### options + +▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Inherited from + +[Axios](../classes/internal.Axios.md).[options](../classes/internal.Axios.md#options) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:181 + +___ + +### patch + +▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `data?` | `D` | +| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Inherited from + +[Axios](../classes/internal.Axios.md).[patch](../classes/internal.Axios.md#patch) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:184 + +___ + +### post + +▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `data?` | `D` | +| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Inherited from + +[Axios](../classes/internal.Axios.md).[post](../classes/internal.Axios.md#post) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:182 + +___ + +### put + +▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `data?` | `D` | +| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Inherited from + +[Axios](../classes/internal.Axios.md).[put](../classes/internal.Axios.md#put) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:183 + +___ + +### request + +▸ **request**<`T`, `R`, `D`\>(`config`): [`Promise`](../modules/internal.md#promise)<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`R`\> + +#### Inherited from + +[Axios](../classes/internal.Axios.md).[request](../classes/internal.Axios.md#request) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:177 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosInterceptorManager.md b/docs/content/references/js-client/interfaces/internal.AxiosInterceptorManager.md new file mode 100644 index 0000000000..2df8a4679a --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.AxiosInterceptorManager.md @@ -0,0 +1,60 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosInterceptorManager + +[internal](../modules/internal.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`](../modules/internal.md#promise)<`T`\> | +| `onRejected?` | (`error`: `any`) => `any` | + +#### Returns + +`number` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:165 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosPromise.md b/docs/content/references/js-client/interfaces/internal.AxiosPromise.md new file mode 100644 index 0000000000..03b239236e --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.AxiosPromise.md @@ -0,0 +1,132 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosPromise + +[internal](../modules/internal.md).AxiosPromise + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | + +## Hierarchy + +- [`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.AxiosResponse.md)<`T`\>\> + + ↳ **`AxiosPromise`** + +## Properties + +### [toStringTag] + +• `Readonly` **[toStringTag]**: `string` + +#### Inherited from + +Promise.\_\_@toStringTag@311 + +#### Defined in + +node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:174 + +## Methods + +### catch + +▸ **catch**<`TResult`\>(`onrejected?`): [`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.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.PromiseLike.md)<`TResult`\> | The callback to execute when the Promise is rejected. | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> \| `TResult`\> + +A Promise for the completion of the callback. + +#### Inherited from + +Promise.catch + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1509 + +___ + +### finally + +▸ **finally**(`onfinally?`): [`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.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`](../modules/internal.md#promise)<[`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\>\> + +A Promise for the completion of the callback. + +#### Inherited from + +Promise.finally + +#### Defined in + +node_modules/typescript/lib/lib.es2018.promise.d.ts:31 + +___ + +### then + +▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`Promise`](../modules/internal.md#promise)<`TResult1` \| `TResult2`\> + +Attaches callbacks for the resolution and/or rejection of the Promise. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TResult1` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | +| `TResult2` | `never` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `onfulfilled?` | ``null`` \| (`value`: [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\>) => `TResult1` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | +| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`TResult1` \| `TResult2`\> + +A Promise for the completion of which ever callback is executed. + +#### Inherited from + +Promise.then + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1502 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosProxyConfig.md b/docs/content/references/js-client/interfaces/internal.AxiosProxyConfig.md new file mode 100644 index 0000000000..c8380da09e --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.AxiosProxyConfig.md @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosProxyConfig + +[internal](../modules/internal.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/docs/content/references/js-client/interfaces/internal.AxiosRequestConfig.md b/docs/content/references/js-client/interfaces/internal.AxiosRequestConfig.md new file mode 100644 index 0000000000..d14d710596 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.AxiosRequestConfig.md @@ -0,0 +1,373 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosRequestConfig + +[internal](../modules/internal.md).AxiosRequestConfig + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `D` | `any` | + +## Properties + +### adapter + +• `Optional` **adapter**: [`AxiosAdapter`](internal.AxiosAdapter.md) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:75 + +___ + +### auth + +• `Optional` **auth**: [`AxiosBasicCredentials`](internal.AxiosBasicCredentials.md) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:76 + +___ + +### baseURL + +• `Optional` **baseURL**: `string` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:65 + +___ + +### cancelToken + +• `Optional` **cancelToken**: [`CancelToken`](internal.CancelToken.md) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:90 + +___ + +### data + +• `Optional` **data**: `D` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:71 + +___ + +### decompress + +• `Optional` **decompress**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:91 + +___ + +### headers + +• `Optional` **headers**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:68 + +___ + +### httpAgent + +• `Optional` **httpAgent**: `any` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:87 + +___ + +### httpsAgent + +• `Optional` **httpsAgent**: `any` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:88 + +___ + +### insecureHTTPParser + +• `Optional` **insecureHTTPParser**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:94 + +___ + +### maxBodyLength + +• `Optional` **maxBodyLength**: `number` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:84 + +___ + +### maxContentLength + +• `Optional` **maxContentLength**: `number` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:82 + +___ + +### maxRedirects + +• `Optional` **maxRedirects**: `number` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:85 + +___ + +### method + +• `Optional` **method**: [`Method`](../modules/internal.md#method) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:64 + +___ + +### params + +• `Optional` **params**: `any` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:69 + +___ + +### proxy + +• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](internal.AxiosProxyConfig.md) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:89 + +___ + +### raxConfig + +• `Optional` **raxConfig**: [`RetryConfig`](internal.RetryConfig.md) + +#### Defined in + +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89 + +___ + +### responseType + +• `Optional` **responseType**: [`ResponseType`](../modules/internal.md#responsetype) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:77 + +___ + +### signal + +• `Optional` **signal**: [`AbortSignal`](../modules/internal.md#abortsignal) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:93 + +___ + +### socketPath + +• `Optional` **socketPath**: ``null`` \| `string` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:86 + +___ + +### timeout + +• `Optional` **timeout**: `number` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:72 + +___ + +### timeoutErrorMessage + +• `Optional` **timeoutErrorMessage**: `string` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:73 + +___ + +### transformRequest + +• `Optional` **transformRequest**: [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md)[] + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:66 + +___ + +### transformResponse + +• `Optional` **transformResponse**: [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md)[] + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:67 + +___ + +### transitional + +• `Optional` **transitional**: [`TransitionalOptions`](internal.TransitionalOptions.md) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:92 + +___ + +### url + +• `Optional` **url**: `string` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:63 + +___ + +### validateStatus + +• `Optional` **validateStatus**: ``null`` \| (`status`: `number`) => `boolean` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:83 + +___ + +### withCredentials + +• `Optional` **withCredentials**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:74 + +___ + +### xsrfCookieName + +• `Optional` **xsrfCookieName**: `string` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:78 + +___ + +### xsrfHeaderName + +• `Optional` **xsrfHeaderName**: `string` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:79 + +## Methods + +### onDownloadProgress + +▸ `Optional` **onDownloadProgress**(`progressEvent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `progressEvent` | `any` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:81 + +___ + +### onUploadProgress + +▸ `Optional` **onUploadProgress**(`progressEvent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `progressEvent` | `any` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:80 + +___ + +### paramsSerializer + +▸ `Optional` **paramsSerializer**(`params`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `any` | + +#### Returns + +`string` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:70 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosRequestTransformer.md b/docs/content/references/js-client/interfaces/internal.AxiosRequestTransformer.md new file mode 100644 index 0000000000..59aadba96e --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.AxiosRequestTransformer.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosRequestTransformer + +[internal](../modules/internal.md).AxiosRequestTransformer + +## Callable + +### AxiosRequestTransformer + +▸ **AxiosRequestTransformer**(`data`, `headers?`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `any` | +| `headers?` | [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) | + +#### Returns + +`any` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:10 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosResponse.md b/docs/content/references/js-client/interfaces/internal.AxiosResponse.md new file mode 100644 index 0000000000..62ff394b53 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.AxiosResponse.md @@ -0,0 +1,74 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosResponse + +[internal](../modules/internal.md).AxiosResponse + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `D` | `any` | + +## Properties + +### config + +• **config**: [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`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.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/docs/content/references/js-client/interfaces/internal.AxiosResponseTransformer.md b/docs/content/references/js-client/interfaces/internal.AxiosResponseTransformer.md new file mode 100644 index 0000000000..5a6b5b4860 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.AxiosResponseTransformer.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosResponseTransformer + +[internal](../modules/internal.md).AxiosResponseTransformer + +## Callable + +### AxiosResponseTransformer + +▸ **AxiosResponseTransformer**(`data`, `headers?`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `any` | +| `headers?` | [`AxiosResponseHeaders`](../modules/internal.md#axiosresponseheaders) | + +#### Returns + +`any` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:14 diff --git a/docs/content/references/js-client/interfaces/internal.CallSite.md b/docs/content/references/js-client/interfaces/internal.CallSite.md new file mode 100644 index 0000000000..b5f5ac73b7 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.CallSite.md @@ -0,0 +1,222 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: CallSite + +[internal](../modules/internal.md).CallSite + +## Methods + +### getColumnNumber + +▸ **getColumnNumber**(): ``null`` \| `number` + +Current column number [if this function was defined in a script] + +#### Returns + +``null`` \| `number` + +#### Defined in + +node_modules/@types/node/globals.d.ts:154 + +___ + +### 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 + +node_modules/@types/node/globals.d.ts:160 + +___ + +### getFileName + +▸ **getFileName**(): ``null`` \| `string` + +Name of the script [if this function was defined in a script] + +#### Returns + +``null`` \| `string` + +#### Defined in + +node_modules/@types/node/globals.d.ts:144 + +___ + +### getFunction + +▸ **getFunction**(): `undefined` \| [`Function`](../modules/internal.md#function) + +Current function + +#### Returns + +`undefined` \| [`Function`](../modules/internal.md#function) + +#### Defined in + +node_modules/@types/node/globals.d.ts:126 + +___ + +### 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 + +node_modules/@types/node/globals.d.ts:133 + +___ + +### getLineNumber + +▸ **getLineNumber**(): ``null`` \| `number` + +Current line number [if this function was defined in a script] + +#### Returns + +``null`` \| `number` + +#### Defined in + +node_modules/@types/node/globals.d.ts:149 + +___ + +### 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 + +node_modules/@types/node/globals.d.ts:139 + +___ + +### getThis + +▸ **getThis**(): `unknown` + +Value of "this" + +#### Returns + +`unknown` + +#### Defined in + +node_modules/@types/node/globals.d.ts:113 + +___ + +### 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 + +node_modules/@types/node/globals.d.ts:121 + +___ + +### isConstructor + +▸ **isConstructor**(): `boolean` + +Is this a constructor call? + +#### Returns + +`boolean` + +#### Defined in + +node_modules/@types/node/globals.d.ts:180 + +___ + +### isEval + +▸ **isEval**(): `boolean` + +Does this call take place in code defined by a call to eval? + +#### Returns + +`boolean` + +#### Defined in + +node_modules/@types/node/globals.d.ts:170 + +___ + +### isNative + +▸ **isNative**(): `boolean` + +Is this call in native V8 code? + +#### Returns + +`boolean` + +#### Defined in + +node_modules/@types/node/globals.d.ts:175 + +___ + +### isToplevel + +▸ **isToplevel**(): `boolean` + +Is this a toplevel invocation, that is, is "this" the global object? + +#### Returns + +`boolean` + +#### Defined in + +node_modules/@types/node/globals.d.ts:165 diff --git a/docs/content/references/js-client/interfaces/internal.Cancel.md b/docs/content/references/js-client/interfaces/internal.Cancel.md new file mode 100644 index 0000000000..b9d3f0ddde --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.Cancel.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Cancel + +[internal](../modules/internal.md).Cancel + +## Properties + +### message + +• **message**: `string` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:141 diff --git a/docs/content/references/js-client/interfaces/internal.CancelToken.md b/docs/content/references/js-client/interfaces/internal.CancelToken.md new file mode 100644 index 0000000000..fa8a9347d0 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.CancelToken.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: CancelToken + +[internal](../modules/internal.md).CancelToken + +## Properties + +### promise + +• **promise**: [`Promise`](../modules/internal.md#promise)<[`Cancel`](internal.Cancel.md)\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:154 + +___ + +### reason + +• `Optional` **reason**: [`Cancel`](internal.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/docs/content/references/js-client/interfaces/internal.Config.md b/docs/content/references/js-client/interfaces/internal.Config.md new file mode 100644 index 0000000000..4a8f1ab709 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.Config.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Config + +[internal](../modules/internal.md).Config + +## Properties + +### apiKey + +• `Optional` **apiKey**: `string` + +#### Defined in + +[packages/medusa-js/src/request.ts:14](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L14) + +___ + +### baseUrl + +• **baseUrl**: `string` + +#### Defined in + +[packages/medusa-js/src/request.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L12) + +___ + +### maxRetries + +• **maxRetries**: `number` + +#### Defined in + +[packages/medusa-js/src/request.ts:13](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L13) diff --git a/docs/content/references/js-client/interfaces/internal.Date.md b/docs/content/references/js-client/interfaces/internal.Date.md new file mode 100644 index 0000000000..7c3550c8c5 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.Date.md @@ -0,0 +1,948 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Date + +[internal](../modules/internal.md).Date + +Enables basic storage and retrieval of dates and times. + +## Methods + +### [toPrimitive] + +▸ **[toPrimitive]**(`hint`): `string` + +Converts a Date object to a string. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `hint` | ``"default"`` | + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:114 + +▸ **[toPrimitive]**(`hint`): `string` + +Converts a Date object to a string. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `hint` | ``"string"`` | + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:118 + +▸ **[toPrimitive]**(`hint`): `number` + +Converts a Date object to a number. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `hint` | ``"number"`` | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:122 + +▸ **[toPrimitive]**(`hint`): `string` \| `number` + +Converts a Date object to a string or number. + +**`throws`** {TypeError} If 'hint' was given something other than "number", "string", or "default". + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `hint` | `string` | The strings "number", "string", or "default" to specify what primitive to return. | + +#### Returns + +`string` \| `number` + +A number if 'hint' was "number", a string if 'hint' was "string" or "default". + +#### Defined in + +node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:131 + +___ + +### getDate + +▸ **getDate**(): `number` + +Gets the day-of-the-month, using local time. + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:775 + +___ + +### getDay + +▸ **getDay**(): `number` + +Gets the day of the week, using local time. + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:779 + +___ + +### getFullYear + +▸ **getFullYear**(): `number` + +Gets the year, using local time. + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:767 + +___ + +### getHours + +▸ **getHours**(): `number` + +Gets the hours in a date, using local time. + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:783 + +___ + +### getMilliseconds + +▸ **getMilliseconds**(): `number` + +Gets the milliseconds of a Date, using local time. + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:795 + +___ + +### getMinutes + +▸ **getMinutes**(): `number` + +Gets the minutes of a Date object, using local time. + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:787 + +___ + +### getMonth + +▸ **getMonth**(): `number` + +Gets the month, using local time. + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:771 + +___ + +### getSeconds + +▸ **getSeconds**(): `number` + +Gets the seconds of a Date object, using local time. + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:791 + +___ + +### getTime + +▸ **getTime**(): `number` + +Gets the time value in milliseconds. + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:765 + +___ + +### getTimezoneOffset + +▸ **getTimezoneOffset**(): `number` + +Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC). + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:799 + +___ + +### getUTCDate + +▸ **getUTCDate**(): `number` + +Gets the day-of-the-month, using Universal Coordinated Time (UTC). + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:777 + +___ + +### getUTCDay + +▸ **getUTCDay**(): `number` + +Gets the day of the week using Universal Coordinated Time (UTC). + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:781 + +___ + +### getUTCFullYear + +▸ **getUTCFullYear**(): `number` + +Gets the year using Universal Coordinated Time (UTC). + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:769 + +___ + +### getUTCHours + +▸ **getUTCHours**(): `number` + +Gets the hours value in a Date object using Universal Coordinated Time (UTC). + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:785 + +___ + +### getUTCMilliseconds + +▸ **getUTCMilliseconds**(): `number` + +Gets the milliseconds of a Date object using Universal Coordinated Time (UTC). + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:797 + +___ + +### getUTCMinutes + +▸ **getUTCMinutes**(): `number` + +Gets the minutes of a Date object using Universal Coordinated Time (UTC). + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:789 + +___ + +### getUTCMonth + +▸ **getUTCMonth**(): `number` + +Gets the month of a Date object using Universal Coordinated Time (UTC). + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:773 + +___ + +### getUTCSeconds + +▸ **getUTCSeconds**(): `number` + +Gets the seconds of a Date object using Universal Coordinated Time (UTC). + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:793 + +___ + +### setDate + +▸ **setDate**(`date`): `number` + +Sets the numeric day-of-the-month value of the Date object using local time. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `date` | `number` | A numeric value equal to the day of the month. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:862 + +___ + +### setFullYear + +▸ **setFullYear**(`year`, `month?`, `date?`): `number` + +Sets the year of the Date object using local time. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `year` | `number` | A numeric value for the year. | +| `month?` | `number` | A zero-based numeric value for the month (0 for January, 11 for December). Must be specified if numDate is specified. | +| `date?` | `number` | A numeric value equal for the day of the month. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:886 + +___ + +### setHours + +▸ **setHours**(`hours`, `min?`, `sec?`, `ms?`): `number` + +Sets the hour value in the Date object using local time. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `hours` | `number` | A numeric value equal to the hours value. | +| `min?` | `number` | A numeric value equal to the minutes value. | +| `sec?` | `number` | A numeric value equal to the seconds value. | +| `ms?` | `number` | A numeric value equal to the milliseconds value. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:849 + +___ + +### setMilliseconds + +▸ **setMilliseconds**(`ms`): `number` + +Sets the milliseconds value in the Date object using local time. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `ms` | `number` | A numeric value equal to the millisecond value. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:809 + +___ + +### setMinutes + +▸ **setMinutes**(`min`, `sec?`, `ms?`): `number` + +Sets the minutes value in the Date object using local time. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `min` | `number` | A numeric value equal to the minutes value. | +| `sec?` | `number` | A numeric value equal to the seconds value. | +| `ms?` | `number` | A numeric value equal to the milliseconds value. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:834 + +___ + +### setMonth + +▸ **setMonth**(`month`, `date?`): `number` + +Sets the month value in the Date object using local time. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `month` | `number` | A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. | +| `date?` | `number` | A numeric value representing the day of the month. If this value is not supplied, the value from a call to the getDate method is used. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:873 + +___ + +### setSeconds + +▸ **setSeconds**(`sec`, `ms?`): `number` + +Sets the seconds value in the Date object using local time. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `sec` | `number` | A numeric value equal to the seconds value. | +| `ms?` | `number` | A numeric value equal to the milliseconds value. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:821 + +___ + +### setTime + +▸ **setTime**(`time`): `number` + +Sets the date and time value in the Date object. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `time` | `number` | A numeric value representing the number of elapsed milliseconds since midnight, January 1, 1970 GMT. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:804 + +___ + +### setUTCDate + +▸ **setUTCDate**(`date`): `number` + +Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC). + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `date` | `number` | A numeric value equal to the day of the month. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:867 + +___ + +### setUTCFullYear + +▸ **setUTCFullYear**(`year`, `month?`, `date?`): `number` + +Sets the year value in the Date object using Universal Coordinated Time (UTC). + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `year` | `number` | A numeric value equal to the year. | +| `month?` | `number` | A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. Must be supplied if numDate is supplied. | +| `date?` | `number` | A numeric value equal to the day of the month. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:893 + +___ + +### setUTCHours + +▸ **setUTCHours**(`hours`, `min?`, `sec?`, `ms?`): `number` + +Sets the hours value in the Date object using Universal Coordinated Time (UTC). + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `hours` | `number` | A numeric value equal to the hours value. | +| `min?` | `number` | A numeric value equal to the minutes value. | +| `sec?` | `number` | A numeric value equal to the seconds value. | +| `ms?` | `number` | A numeric value equal to the milliseconds value. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:857 + +___ + +### setUTCMilliseconds + +▸ **setUTCMilliseconds**(`ms`): `number` + +Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC). + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `ms` | `number` | A numeric value equal to the millisecond value. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:814 + +___ + +### setUTCMinutes + +▸ **setUTCMinutes**(`min`, `sec?`, `ms?`): `number` + +Sets the minutes value in the Date object using Universal Coordinated Time (UTC). + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `min` | `number` | A numeric value equal to the minutes value. | +| `sec?` | `number` | A numeric value equal to the seconds value. | +| `ms?` | `number` | A numeric value equal to the milliseconds value. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:841 + +___ + +### setUTCMonth + +▸ **setUTCMonth**(`month`, `date?`): `number` + +Sets the month value in the Date object using Universal Coordinated Time (UTC). + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `month` | `number` | A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. | +| `date?` | `number` | A numeric value representing the day of the month. If it is not supplied, the value from a call to the getUTCDate method is used. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:879 + +___ + +### setUTCSeconds + +▸ **setUTCSeconds**(`sec`, `ms?`): `number` + +Sets the seconds value in the Date object using Universal Coordinated Time (UTC). + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `sec` | `number` | A numeric value equal to the seconds value. | +| `ms?` | `number` | A numeric value equal to the milliseconds value. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:827 + +___ + +### toDateString + +▸ **toDateString**(): `string` + +Returns a date as a string value. + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:753 + +___ + +### toISOString + +▸ **toISOString**(): `string` + +Returns a date as a string value in ISO format. + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:897 + +___ + +### toJSON + +▸ **toJSON**(`key?`): `string` + +Used by the JSON.stringify method to enable the transformation of an object's data for JavaScript Object Notation (JSON) serialization. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key?` | `any` | + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:899 + +___ + +### toLocaleDateString + +▸ **toLocaleDateString**(): `string` + +Returns a date as a string value appropriate to the host environment's current locale. + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:759 + +▸ **toLocaleDateString**(`locales?`, `options?`): `string` + +Converts a date to a string by using the current or specified locale. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. | +| `options?` | [`DateTimeFormatOptions`](internal.DateTimeFormatOptions.md) | An object that contains one or more properties that specify comparison options. | + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4487 + +___ + +### toLocaleString + +▸ **toLocaleString**(): `string` + +Returns a value as a string value appropriate to the host environment's current locale. + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:757 + +▸ **toLocaleString**(`locales?`, `options?`): `string` + +Converts a date and time to a string by using the current or specified locale. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. | +| `options?` | [`DateTimeFormatOptions`](internal.DateTimeFormatOptions.md) | An object that contains one or more properties that specify comparison options. | + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4481 + +___ + +### toLocaleTimeString + +▸ **toLocaleTimeString**(): `string` + +Returns a time as a string value appropriate to the host environment's current locale. + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:761 + +▸ **toLocaleTimeString**(`locales?`, `options?`): `string` + +Converts a time to a string by using the current or specified locale. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. | +| `options?` | [`DateTimeFormatOptions`](internal.DateTimeFormatOptions.md) | An object that contains one or more properties that specify comparison options. | + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4494 + +___ + +### toString + +▸ **toString**(): `string` + +Returns a string representation of a date. The format of the string depends on the locale. + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:751 + +___ + +### toTimeString + +▸ **toTimeString**(): `string` + +Returns a time as a string value. + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:755 + +___ + +### toUTCString + +▸ **toUTCString**(): `string` + +Returns a date converted to a string using Universal Coordinated Time (UTC). + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:895 + +___ + +### valueOf + +▸ **valueOf**(): `number` + +Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC. + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:763 diff --git a/docs/content/references/js-client/interfaces/internal.DateConstructor.md b/docs/content/references/js-client/interfaces/internal.DateConstructor.md new file mode 100644 index 0000000000..d914a797ac --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.DateConstructor.md @@ -0,0 +1,95 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: DateConstructor + +[internal](../modules/internal.md).DateConstructor + +## Callable + +### DateConstructor + +▸ **DateConstructor**(): `string` + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:906 + +## Properties + +### prototype + +• `Readonly` **prototype**: [`Date`](../modules/internal.md#date) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:907 + +## Methods + +### UTC + +▸ **UTC**(`year`, `month`, `date?`, `hours?`, `minutes?`, `seconds?`, `ms?`): `number` + +Returns the number of milliseconds between midnight, January 1, 1970 Universal Coordinated Time (UTC) (or GMT) and the specified date. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `year` | `number` | The full year designation is required for cross-century date accuracy. If year is between 0 and 99 is used, then year is assumed to be 1900 + year. | +| `month` | `number` | The month as a number between 0 and 11 (January to December). | +| `date?` | `number` | The date as a number between 1 and 31. | +| `hours?` | `number` | Must be supplied if minutes is supplied. A number from 0 to 23 (midnight to 11pm) that specifies the hour. | +| `minutes?` | `number` | Must be supplied if seconds is supplied. A number from 0 to 59 that specifies the minutes. | +| `seconds?` | `number` | Must be supplied if milliseconds is supplied. A number from 0 to 59 that specifies the seconds. | +| `ms?` | `number` | A number from 0 to 999 that specifies the milliseconds. | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:923 + +___ + +### now + +▸ **now**(): `number` + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:924 + +___ + +### parse + +▸ **parse**(`s`): `number` + +Parses a string containing a date, and returns the number of milliseconds between that date and midnight, January 1, 1970. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `s` | `string` | A date string | + +#### Returns + +`number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:912 diff --git a/docs/content/references/js-client/interfaces/internal.DateTimeFormatOptions.md b/docs/content/references/js-client/interfaces/internal.DateTimeFormatOptions.md new file mode 100644 index 0000000000..4db4e7c23b --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.DateTimeFormatOptions.md @@ -0,0 +1,197 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: DateTimeFormatOptions + +[internal](../modules/internal.md).DateTimeFormatOptions + +## Properties + +### calendar + +• `Optional` **calendar**: `string` + +#### Defined in + +node_modules/typescript/lib/lib.es2020.intl.d.ts:237 + +___ + +### dateStyle + +• `Optional` **dateStyle**: ``"long"`` \| ``"short"`` \| ``"full"`` \| ``"medium"`` + +#### Defined in + +node_modules/typescript/lib/lib.es2020.intl.d.ts:241 + +___ + +### day + +• `Optional` **day**: ``"numeric"`` \| ``"2-digit"`` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4418 + +___ + +### dayPeriod + +• `Optional` **dayPeriod**: ``"long"`` \| ``"short"`` \| ``"narrow"`` + +#### Defined in + +node_modules/typescript/lib/lib.es2020.intl.d.ts:238 + +___ + +### era + +• `Optional` **era**: ``"long"`` \| ``"short"`` \| ``"narrow"`` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4415 + +___ + +### formatMatcher + +• `Optional` **formatMatcher**: ``"best fit"`` \| ``"basic"`` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4423 + +___ + +### hour + +• `Optional` **hour**: ``"numeric"`` \| ``"2-digit"`` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4419 + +___ + +### hour12 + +• `Optional` **hour12**: `boolean` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4424 + +___ + +### hourCycle + +• `Optional` **hourCycle**: ``"h11"`` \| ``"h12"`` \| ``"h23"`` \| ``"h24"`` + +#### Defined in + +node_modules/typescript/lib/lib.es2020.intl.d.ts:243 + +___ + +### localeMatcher + +• `Optional` **localeMatcher**: ``"best fit"`` \| ``"lookup"`` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4413 + +___ + +### minute + +• `Optional` **minute**: ``"numeric"`` \| ``"2-digit"`` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4420 + +___ + +### month + +• `Optional` **month**: ``"long"`` \| ``"short"`` \| ``"narrow"`` \| ``"numeric"`` \| ``"2-digit"`` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4417 + +___ + +### numberingSystem + +• `Optional` **numberingSystem**: `string` + +#### Defined in + +node_modules/typescript/lib/lib.es2020.intl.d.ts:239 + +___ + +### second + +• `Optional` **second**: ``"numeric"`` \| ``"2-digit"`` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4421 + +___ + +### timeStyle + +• `Optional` **timeStyle**: ``"long"`` \| ``"short"`` \| ``"full"`` \| ``"medium"`` + +#### Defined in + +node_modules/typescript/lib/lib.es2020.intl.d.ts:242 + +___ + +### timeZone + +• `Optional` **timeZone**: `string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4425 + +___ + +### timeZoneName + +• `Optional` **timeZoneName**: ``"long"`` \| ``"short"`` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4422 + +___ + +### weekday + +• `Optional` **weekday**: ``"long"`` \| ``"short"`` \| ``"narrow"`` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4414 + +___ + +### year + +• `Optional` **year**: ``"numeric"`` \| ``"2-digit"`` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:4416 diff --git a/docs/content/references/js-client/interfaces/internal.Error.md b/docs/content/references/js-client/interfaces/internal.Error.md new file mode 100644 index 0000000000..e1fb246c7b --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.Error.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Error + +[internal](../modules/internal.md).Error + +## Properties + +### message + +• **message**: `string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1023 + +___ + +### name + +• **name**: `string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1022 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1024 diff --git a/docs/content/references/js-client/interfaces/internal.ErrorConstructor.md b/docs/content/references/js-client/interfaces/internal.ErrorConstructor.md new file mode 100644 index 0000000000..e51b3b673f --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.ErrorConstructor.md @@ -0,0 +1,99 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ErrorConstructor + +[internal](../modules/internal.md).ErrorConstructor + +## Callable + +### ErrorConstructor + +▸ **ErrorConstructor**(`message?`): [`Error`](../modules/internal.md#error) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`Error`](../modules/internal.md#error) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1029 + +## Properties + +### prepareStackTrace + +• `Optional` **prepareStackTrace**: (`err`: [`Error`](../modules/internal.md#error), `stackTraces`: [`CallSite`](internal.CallSite.md)[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Error`](../modules/internal.md#error) | +| `stackTraces` | [`CallSite`](internal.CallSite.md)[] | + +##### Returns + +`any` + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### prototype + +• `Readonly` **prototype**: [`Error`](../modules/internal.md#error) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1030 + +___ + +### stackTraceLimit + +• **stackTraceLimit**: `number` + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | [`Function`](../modules/internal.md#function) | + +#### Returns + +`void` + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/content/references/js-client/interfaces/internal.Function.md b/docs/content/references/js-client/interfaces/internal.Function.md new file mode 100644 index 0000000000..15c50e6979 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.Function.md @@ -0,0 +1,176 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Function + +[internal](../modules/internal.md).Function + +Creates a new function. + +## Properties + +### arguments + +• **arguments**: `any` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:304 + +___ + +### caller + +• **caller**: [`Function`](../modules/internal.md#function) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:305 + +___ + +### length + +• `Readonly` **length**: `number` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:301 + +___ + +### name + +• `Readonly` **name**: `string` + +Returns the name of the function. Function names are read-only and can not be changed. + +#### Defined in + +node_modules/typescript/lib/lib.es2015.core.d.ts:97 + +___ + +### prototype + +• **prototype**: `any` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:300 + +## Methods + +### [hasInstance] + +▸ **[hasInstance]**(`value`): `boolean` + +Determines whether the given value inherits from this function if this function was used +as a constructor function. + +A constructor function can control which objects are recognized as its instances by +'instanceof' by overriding this method. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `any` | + +#### Returns + +`boolean` + +#### Defined in + +node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:162 + +___ + +### apply + +▸ **apply**(`this`, `thisArg`, `argArray?`): `any` + +Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `this` | [`Function`](../modules/internal.md#function) | - | +| `thisArg` | `any` | The object to be used as the this object. | +| `argArray?` | `any` | A set of arguments to be passed to the function. | + +#### Returns + +`any` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:280 + +___ + +### bind + +▸ **bind**(`this`, `thisArg`, ...`argArray`): `any` + +For a given function, creates a bound function that has the same body as the original function. +The this object of the bound function is associated with the specified object, and has the specified initial parameters. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `this` | [`Function`](../modules/internal.md#function) | - | +| `thisArg` | `any` | An object to which the this keyword can refer inside the new function. | +| `...argArray` | `any`[] | A list of arguments to be passed to the new function. | + +#### Returns + +`any` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:295 + +___ + +### call + +▸ **call**(`this`, `thisArg`, ...`argArray`): `any` + +Calls a method of an object, substituting another object for the current object. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `this` | [`Function`](../modules/internal.md#function) | - | +| `thisArg` | `any` | The object to be used as the current object. | +| `...argArray` | `any`[] | A list of arguments to be passed to the method. | + +#### Returns + +`any` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:287 + +___ + +### toString + +▸ **toString**(): `string` + +Returns a string representation of a function. + +#### Returns + +`string` + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:298 diff --git a/docs/content/references/js-client/interfaces/internal.FunctionConstructor.md b/docs/content/references/js-client/interfaces/internal.FunctionConstructor.md new file mode 100644 index 0000000000..36c39878e0 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.FunctionConstructor.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: FunctionConstructor + +[internal](../modules/internal.md).FunctionConstructor + +## Callable + +### FunctionConstructor + +▸ **FunctionConstructor**(...`args`): [`Function`](../modules/internal.md#function) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | `string`[] | + +#### Returns + +[`Function`](../modules/internal.md#function) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:314 + +## Properties + +### prototype + +• `Readonly` **prototype**: [`Function`](../modules/internal.md#function) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:315 diff --git a/docs/content/references/js-client/interfaces/internal.HTTPResponse.md b/docs/content/references/js-client/interfaces/internal.HTTPResponse.md new file mode 100644 index 0000000000..5e981c2645 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.HTTPResponse.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: HTTPResponse + +[internal](../modules/internal.md).HTTPResponse + +## Properties + +### config + +• **config**: `any` + +#### Defined in + +[packages/medusa-js/src/typings.ts:13](https://github.com/medusajs/medusa/blob/2eb2126f/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/2eb2126f/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/2eb2126f/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/2eb2126f/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/2eb2126f/packages/medusa-js/src/typings.ts#L9) diff --git a/docs/content/references/js-client/interfaces/internal.HeadersDefaults.md b/docs/content/references/js-client/interfaces/internal.HeadersDefaults.md new file mode 100644 index 0000000000..0d7d9111c7 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.HeadersDefaults.md @@ -0,0 +1,117 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: HeadersDefaults + +[internal](../modules/internal.md).HeadersDefaults + +## Properties + +### common + +• **common**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:98 + +___ + +### delete + +• **delete**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:99 + +___ + +### get + +• **get**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:100 + +___ + +### head + +• **head**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:101 + +___ + +### link + +• `Optional` **link**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:107 + +___ + +### options + +• `Optional` **options**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:105 + +___ + +### patch + +• **patch**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:104 + +___ + +### post + +• **post**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:102 + +___ + +### purge + +• `Optional` **purge**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:106 + +___ + +### put + +• **put**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:103 + +___ + +### unlink + +• `Optional` **unlink**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:108 diff --git a/docs/content/references/js-client/interfaces/internal.Iterable.md b/docs/content/references/js-client/interfaces/internal.Iterable.md new file mode 100644 index 0000000000..1c308f9a19 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.Iterable.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Iterable + +[internal](../modules/internal.md).Iterable + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Methods + +### [iterator] + +▸ **[iterator]**(): [`Iterator`](internal.Iterator.md)<`T`, `any`, `undefined`\> + +#### Returns + +[`Iterator`](internal.Iterator.md)<`T`, `any`, `undefined`\> + +#### Defined in + +node_modules/typescript/lib/lib.es2015.iterable.d.ts:51 diff --git a/docs/content/references/js-client/interfaces/internal.Iterator.md b/docs/content/references/js-client/interfaces/internal.Iterator.md new file mode 100644 index 0000000000..533ec361c1 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.Iterator.md @@ -0,0 +1,75 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Iterator + +[internal](../modules/internal.md).Iterator + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `TReturn` | `any` | +| `TNext` | `undefined` | + +## Methods + +### next + +▸ **next**(...`args`): [`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | [] \| [`TNext`] | + +#### Returns + +[`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\> + +#### Defined in + +node_modules/typescript/lib/lib.es2015.iterable.d.ts:45 + +___ + +### return + +▸ `Optional` **return**(`value?`): [`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value?` | `TReturn` | + +#### Returns + +[`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\> + +#### Defined in + +node_modules/typescript/lib/lib.es2015.iterable.d.ts:46 + +___ + +### throw + +▸ `Optional` **throw**(`e?`): [`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `e?` | `any` | + +#### Returns + +[`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\> + +#### Defined in + +node_modules/typescript/lib/lib.es2015.iterable.d.ts:47 diff --git a/docs/content/references/js-client/interfaces/internal.IteratorReturnResult.md b/docs/content/references/js-client/interfaces/internal.IteratorReturnResult.md new file mode 100644 index 0000000000..11c3891a0f --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.IteratorReturnResult.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: IteratorReturnResult + +[internal](../modules/internal.md).IteratorReturnResult + +## Type parameters + +| Name | +| :------ | +| `TReturn` | + +## Properties + +### done + +• **done**: ``true`` + +#### Defined in + +node_modules/typescript/lib/lib.es2015.iterable.d.ts:37 + +___ + +### value + +• **value**: `TReturn` + +#### Defined in + +node_modules/typescript/lib/lib.es2015.iterable.d.ts:38 diff --git a/docs/content/references/js-client/interfaces/internal.IteratorYieldResult.md b/docs/content/references/js-client/interfaces/internal.IteratorYieldResult.md new file mode 100644 index 0000000000..27e228d12f --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.IteratorYieldResult.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: IteratorYieldResult + +[internal](../modules/internal.md).IteratorYieldResult + +## Type parameters + +| Name | +| :------ | +| `TYield` | + +## Properties + +### done + +• `Optional` **done**: ``false`` + +#### Defined in + +node_modules/typescript/lib/lib.es2015.iterable.d.ts:32 + +___ + +### value + +• **value**: `TYield` + +#### Defined in + +node_modules/typescript/lib/lib.es2015.iterable.d.ts:33 diff --git a/docs/content/references/js-client/interfaces/internal.Promise.md b/docs/content/references/js-client/interfaces/internal.Promise.md new file mode 100644 index 0000000000..9baca2f495 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.Promise.md @@ -0,0 +1,112 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Promise + +[internal](../modules/internal.md).Promise + +Represents the completion of an asynchronous operation + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Properties + +### [toStringTag] + +• `Readonly` **[toStringTag]**: `string` + +#### Defined in + +node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:174 + +## Methods + +### catch + +▸ **catch**<`TResult`\>(`onrejected?`): [`Promise`](../modules/internal.md#promise)<`T` \| `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.PromiseLike.md)<`TResult`\> | The callback to execute when the Promise is rejected. | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`T` \| `TResult`\> + +A Promise for the completion of the callback. + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1509 + +___ + +### finally + +▸ **finally**(`onfinally?`): [`Promise`](../modules/internal.md#promise)<`T`\> + +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`](../modules/internal.md#promise)<`T`\> + +A Promise for the completion of the callback. + +#### Defined in + +node_modules/typescript/lib/lib.es2018.promise.d.ts:31 + +___ + +### then + +▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`Promise`](../modules/internal.md#promise)<`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.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | +| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`TResult1` \| `TResult2`\> + +A Promise for the completion of which ever callback is executed. + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1502 diff --git a/docs/content/references/js-client/interfaces/internal.PromiseConstructor.md b/docs/content/references/js-client/interfaces/internal.PromiseConstructor.md new file mode 100644 index 0000000000..ec58e4ae02 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.PromiseConstructor.md @@ -0,0 +1,277 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: PromiseConstructor + +[internal](../modules/internal.md).PromiseConstructor + +## Properties + +### [species] + +• `Readonly` **[species]**: [`PromiseConstructor`](internal.PromiseConstructor.md) + +#### Defined in + +node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:178 + +___ + +### prototype + +• `Readonly` **prototype**: [`Promise`](../modules/internal.md#promise)<`any`\> + +A reference to the prototype. + +#### Defined in + +node_modules/typescript/lib/lib.es2015.promise.d.ts:25 + +## Methods + +### all + +▸ **all**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`\>[]\> + +Creates a Promise that is resolved with an array of results when all of the provided Promises +resolve, or rejected when any Promise is rejected. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `values` | [`Iterable`](internal.Iterable.md)<`T` \| [`PromiseLike`](internal.PromiseLike.md)<`T`\>\> | An iterable of Promises. | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`\>[]\> + +A new Promise. + +#### Defined in + +node_modules/typescript/lib/lib.es2015.iterable.d.ts:226 + +▸ **all**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<{ -readonly [P in string \| number \| symbol]: Awaited }\> + +Creates a Promise that is resolved with an array of results when all of the provided Promises +resolve, or rejected when any Promise is rejected. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends readonly `unknown`[] \| [] | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `values` | `T` | An array of Promises. | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<{ -readonly [P in string \| number \| symbol]: Awaited }\> + +A new Promise. + +#### Defined in + +node_modules/typescript/lib/lib.es2015.promise.d.ts:41 + +___ + +### allSettled + +▸ **allSettled**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<{ -readonly [P in string \| number \| symbol]: PromiseSettledResult\> }\> + +Creates a Promise that is resolved with an array of results when all +of the provided Promises resolve or reject. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends readonly `unknown`[] \| [] | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `values` | `T` | An array of Promises. | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<{ -readonly [P in string \| number \| symbol]: PromiseSettledResult\> }\> + +A new Promise. + +#### Defined in + +node_modules/typescript/lib/lib.es2020.promise.d.ts:40 + +▸ **allSettled**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<[`PromiseSettledResult`](../modules/internal.md#promisesettledresult)<[`Awaited`](../modules/internal.md#awaited)<`T`\>\>[]\> + +Creates a Promise that is resolved with an array of results when all +of the provided Promises resolve or reject. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `values` | [`Iterable`](internal.Iterable.md)<`T` \| [`PromiseLike`](internal.PromiseLike.md)<`T`\>\> | An array of Promises. | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<[`PromiseSettledResult`](../modules/internal.md#promisesettledresult)<[`Awaited`](../modules/internal.md#awaited)<`T`\>\>[]\> + +A new Promise. + +#### Defined in + +node_modules/typescript/lib/lib.es2020.promise.d.ts:48 + +___ + +### race + +▸ **race**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`\>\> + +Creates a Promise that is resolved or rejected when any of the provided Promises are resolved +or rejected. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `values` | [`Iterable`](internal.Iterable.md)<`T` \| [`PromiseLike`](internal.PromiseLike.md)<`T`\>\> | An iterable of Promises. | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`\>\> + +A new Promise. + +#### Defined in + +node_modules/typescript/lib/lib.es2015.iterable.d.ts:234 + +▸ **race**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`[`number`]\>\> + +Creates a Promise that is resolved or rejected when any of the provided Promises are resolved +or rejected. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends readonly `unknown`[] \| [] | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `values` | `T` | An array of Promises. | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`[`number`]\>\> + +A new Promise. + +#### Defined in + +node_modules/typescript/lib/lib.es2015.promise.d.ts:52 + +___ + +### reject + +▸ **reject**<`T`\>(`reason?`): [`Promise`](../modules/internal.md#promise)<`T`\> + +Creates a new rejected promise for the provided reason. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `never` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reason?` | `any` | The reason the promise was rejected. | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`T`\> + +A new rejected Promise. + +#### Defined in + +node_modules/typescript/lib/lib.es2015.promise.d.ts:62 + +___ + +### resolve + +▸ **resolve**(): [`Promise`](../modules/internal.md#promise)<`void`\> + +Creates a new resolved promise. + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`void`\> + +A resolved promise. + +#### Defined in + +node_modules/typescript/lib/lib.es2015.promise.d.ts:68 + +▸ **resolve**<`T`\>(`value`): [`Promise`](../modules/internal.md#promise)<`T`\> + +Creates a new resolved promise for the provided value. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `T` \| [`PromiseLike`](internal.PromiseLike.md)<`T`\> | A promise. | + +#### Returns + +[`Promise`](../modules/internal.md#promise)<`T`\> + +A promise whose internal state matches the provided promise. + +#### Defined in + +node_modules/typescript/lib/lib.es2015.promise.d.ts:75 diff --git a/docs/content/references/js-client/interfaces/internal.PromiseFulfilledResult.md b/docs/content/references/js-client/interfaces/internal.PromiseFulfilledResult.md new file mode 100644 index 0000000000..edabd243f3 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.PromiseFulfilledResult.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: PromiseFulfilledResult + +[internal](../modules/internal.md).PromiseFulfilledResult + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Properties + +### status + +• **status**: ``"fulfilled"`` + +#### Defined in + +node_modules/typescript/lib/lib.es2020.promise.d.ts:22 + +___ + +### value + +• **value**: `T` + +#### Defined in + +node_modules/typescript/lib/lib.es2020.promise.d.ts:23 diff --git a/docs/content/references/js-client/interfaces/internal.PromiseLike.md b/docs/content/references/js-client/interfaces/internal.PromiseLike.md new file mode 100644 index 0000000000..9dc3e39518 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.PromiseLike.md @@ -0,0 +1,45 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: PromiseLike + +[internal](../modules/internal.md).PromiseLike + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Methods + +### then + +▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](internal.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.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | +| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | + +#### Returns + +[`PromiseLike`](internal.PromiseLike.md)<`TResult1` \| `TResult2`\> + +A Promise for the completion of which ever callback is executed. + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1489 diff --git a/docs/content/references/js-client/interfaces/internal.PromiseRejectedResult.md b/docs/content/references/js-client/interfaces/internal.PromiseRejectedResult.md new file mode 100644 index 0000000000..e7a4544c6c --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.PromiseRejectedResult.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: PromiseRejectedResult + +[internal](../modules/internal.md).PromiseRejectedResult + +## Properties + +### reason + +• **reason**: `any` + +#### Defined in + +node_modules/typescript/lib/lib.es2020.promise.d.ts:28 + +___ + +### status + +• **status**: ``"rejected"`` + +#### Defined in + +node_modules/typescript/lib/lib.es2020.promise.d.ts:27 diff --git a/docs/content/references/js-client/interfaces/internal.RequestOptions.md b/docs/content/references/js-client/interfaces/internal.RequestOptions.md new file mode 100644 index 0000000000..da16462200 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.RequestOptions.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: RequestOptions + +[internal](../modules/internal.md).RequestOptions + +## Properties + +### numberOfRetries + +• `Optional` **numberOfRetries**: `number` + +#### Defined in + +[packages/medusa-js/src/request.ts:18](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L18) + +___ + +### timeout + +• `Optional` **timeout**: `number` + +#### Defined in + +[packages/medusa-js/src/request.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L17) diff --git a/docs/content/references/js-client/interfaces/internal.RetryConfig.md b/docs/content/references/js-client/interfaces/internal.RetryConfig.md new file mode 100644 index 0000000000..c7195f2ae4 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.RetryConfig.md @@ -0,0 +1,187 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: RetryConfig + +[internal](../modules/internal.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.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 + +___ + +### 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 + +___ + +### 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 + +## Methods + +### onRetryAttempt + +▸ `Optional` **onRetryAttempt**(`err`): `void` + +Function to invoke when a retry attempt is made. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:35 + +___ + +### shouldRetry + +▸ `Optional` **shouldRetry**(`err`): `boolean` + +Function to invoke which determines if you should retry + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:39 diff --git a/docs/content/references/js-client/interfaces/internal.TransitionalOptions.md b/docs/content/references/js-client/interfaces/internal.TransitionalOptions.md new file mode 100644 index 0000000000..7fbb2d8253 --- /dev/null +++ b/docs/content/references/js-client/interfaces/internal.TransitionalOptions.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: TransitionalOptions + +[internal](../modules/internal.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/docs/content/references/js-client/modules/internal.md b/docs/content/references/js-client/modules/internal.md new file mode 100644 index 0000000000..17d36f210f --- /dev/null +++ b/docs/content/references/js-client/modules/internal.md @@ -0,0 +1,25 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Namespace: internal + +## Classes + +- [StorePostSwapsReq](../classes/internal.StorePostSwapsReq.md) + +## Type aliases + +### StoreSwapsRes + +Ƭ **StoreSwapsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `swap` | [`Swap`](../classes/internal.Swap.md) | + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/index.d.ts:6 diff --git a/package.json b/package.json index 1f82807537..0c0c3a330a 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,11 @@ "resolve-cwd": "^3.0.0", "ts-jest": "^26.5.6", "typedoc": "^0.22.15", + "typedoc-frontmatter-plugin": "link:docs-util/typedoc-plugins/typedoc-frontmatter-plugin", + "typedoc-monorepo-link-types": "^0.0.2", "typedoc-plugin-markdown": "^3.12.1", + "typedoc-plugin-merge-modules": "^3.1.0", + "typedoc-plugin-reference-excluder": "^1.0.0", "typeorm": "^0.2.31" }, "lint-staged": { @@ -67,6 +71,7 @@ "test:integration:plugins": "jest --config=integration-tests/jest.config.js --projects=integration-tests/plugins", "test:fixtures": "jest --config=docs-util/jest.config.js --runInBand", "generate:services": "typedoc --options typedoc.services.js", + "generate:js-client": "typedoc --options typedoc.js-client.js", "release:snapshot": "changeset publish --no-git-tags --snapshot --tag snapshot" }, "dependencies": { diff --git a/packages/medusa-js/README.md b/packages/medusa-js/README.md index 2ec478b67f..2eae83815d 100644 --- a/packages/medusa-js/README.md +++ b/packages/medusa-js/README.md @@ -6,7 +6,9 @@ The Medusa JS Client provides easy access to the Medusa API from a client writte ## Documentation -See our [API reference](https://docs.medusajs.com/api/store). +You can learn more about this client and how to use it [our documentation](https://docs.medusajs.com/js-client/overview). + +To learn more about the API endpoints that this client allows you to access check out our [API reference](https://docs.medusajs.com/api/store). ## Installation diff --git a/packages/medusa-js/package.json b/packages/medusa-js/package.json index 965010f3d8..cf8179e386 100644 --- a/packages/medusa-js/package.json +++ b/packages/medusa-js/package.json @@ -37,5 +37,6 @@ "prettier": "^2.2.1", "typescript": "^4.1.3" }, - "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e" + "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e", + "homepage": "https://docs.medusajs.com/js-client/overview" } diff --git a/typedoc.js-client.js b/typedoc.js-client.js new file mode 100644 index 0000000000..8ab54c6ab4 --- /dev/null +++ b/typedoc.js-client.js @@ -0,0 +1,27 @@ +const globalTypedocOptions = require("./typedoc") + +module.exports = { + ...globalTypedocOptions, + entryPoints: ["packages/medusa-js/src/resources"], + entryPointStrategy: "expand", + out: ["docs/content/references/js-client"], + tsconfig: "packages/medusa-js/tsconfig.json", + name: "JS Client Reference", + indexTitle: "JS Client Reference", + entryDocument: "index.md", + hideInPageTOC: true, + hideBreadcrumbs: true, + plugin: [ + ...globalTypedocOptions.plugin, + "typedoc-plugin-merge-modules", + "typedoc-plugin-reference-excluder", + "typedoc-monorepo-link-types", + "typedoc-frontmatter-plugin", + ], + exclude: "packages/medusa-js/src/resources/base.ts", + excludeConstructors: true, + frontmatterData: { + displayed_sidebar: "jsClientSidebar", + }, + pagesPattern: "internal\\.", +} diff --git a/www/docs/docusaurus.config.js b/www/docs/docusaurus.config.js index e5b7caf835..a18ec90185 100644 --- a/www/docs/docusaurus.config.js +++ b/www/docs/docusaurus.config.js @@ -68,6 +68,11 @@ module.exports = { sidebarId: "servicesSidebar", label: "Services Reference", }, + { + type: "docSidebar", + sidebarId: "jsClientSidebar", + label: "JS Client Reference", + }, { href: `https://docs.medusajs.com/api/store`, target: "_self", diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index ec3cb36aa2..fbc0eaf994 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -477,5 +477,263 @@ module.exports = { type: 'autogenerated', dirName: 'references/services/classes', // generate sidebar from the docs folder (or versioned_docs/) }, + ], + jsClientSidebar: [ + { + type: "doc", + id: "js-client/overview", + label: "Overview", + }, + { + type: "category", + collapsed: false, + label: "Resources", + items: [ + { + type: "category", + label: "admin", + collapsed: true, + link: { + type: "doc", + id: "references/js-client/classes/Admin", + }, + items: [ + { + type: "doc", + id: "references/js-client/classes/AdminAuthResource", + label: "auth", + }, + { + type: "doc", + id: "references/js-client/classes/AdminCollectionsResource", + label: "collections", + }, + { + type: "doc", + id: "references/js-client/classes/AdminCustomerGroupsResource", + label: "customerGroups", + }, + { + type: "doc", + id: "references/js-client/classes/AdminCustomersResource", + label: "customers", + }, + { + type: "doc", + id: "references/js-client/classes/AdminDiscountsResource", + label: "discounts", + }, + { + type: "doc", + id: "references/js-client/classes/AdminDraftOrdersResource", + label: "draftOrders", + }, + { + type: "doc", + id: "references/js-client/classes/AdminGiftCardsResource", + label: "giftCards", + }, + { + type: "doc", + id: "references/js-client/classes/AdminInvitesResource", + label: "invites", + }, + { + type: "doc", + id: "references/js-client/classes/AdminNotesResource", + label: "notes", + }, + { + type: "doc", + id: "references/js-client/classes/AdminNotificationsResource", + label: "notifications", + }, + { + type: "doc", + id: "references/js-client/classes/AdminOrdersResource", + label: "orders", + }, + { + type: "doc", + id: "references/js-client/classes/AdminPriceListResource", + label: "priceLists", + }, + { + type: "doc", + id: "references/js-client/classes/AdminProductsResource", + label: "products", + }, + { + type: "doc", + id: "references/js-client/classes/AdminProductTagsResource", + label: "productTags", + }, + { + type: "doc", + id: "references/js-client/classes/AdminProductTypesResource", + label: "productTypes", + }, + { + type: "doc", + id: "references/js-client/classes/AdminRegionsResource", + label: "regions", + }, + { + type: "doc", + id: "references/js-client/classes/AdminReturnReasonsResource", + label: "returnReasons", + }, + { + type: "doc", + id: "references/js-client/classes/AdminReturnsResource", + label: "returns", + }, + { + type: "doc", + id: "references/js-client/classes/AdminShippingOptionsResource", + label: "shippingOptions", + }, + { + type: "doc", + id: "references/js-client/classes/AdminShippingProfilesResource", + label: "shippingProfiles", + }, + { + type: "doc", + id: "references/js-client/classes/AdminStoresResource", + label: "store", + }, + { + type: "doc", + id: "references/js-client/classes/AdminSwapsResource", + label: "swaps", + }, + { + type: "doc", + id: "references/js-client/classes/AdminTaxRatesResource", + label: "taxRates", + }, + { + type: "doc", + id: "references/js-client/classes/AdminUploadsResource", + label: "uploads", + }, + { + type: "doc", + id: "references/js-client/classes/AdminUsersResource", + label: "users", + }, + { + type: "doc", + id: "references/js-client/classes/AdminVariantsResource", + label: "variants", + }, + ] + }, + { + type: "doc", + id: "references/js-client/classes/AuthResource", + label: "auth", + }, + { + type: "category", + label: "carts", + link: { + type: "doc", + id: "references/js-client/classes/CartsResource", + }, + collapsed: true, + items: [ + { + type: "doc", + id: "references/js-client/classes/LineItemsResource", + label: "lineItems", + } + ] + }, + { + type: "doc", + id: "references/js-client/classes/CollectionsResource", + label: "collections", + }, + { + type: "category", + label: "customers", + collapsed: true, + link: { + type: "doc", + id: "references/js-client/classes/CustomerResource", + }, + items: [ + { + type: "doc", + id: "references/js-client/classes/AddressesResource", + label: "addresses" + }, + { + type: "doc", + id: "references/js-client/classes/PaymentMethodsResource", + label: "paymentMethods" + } + ] + }, + { + type: "doc", + id: "references/js-client/classes/GiftCardsResource", + label: "giftCards", + }, + { + type: "doc", + id: "references/js-client/classes/OrdersResource", + label: "orders", + }, + { + type: "doc", + id: "references/js-client/classes/PaymentMethodsResource", + label: "paymentMethods", + }, + { + type: "category", + label: "products", + link: { + type: "doc", + id: "references/js-client/classes/ProductsResource", + }, + collapsed: true, + items: [ + { + type: "doc", + id: "references/js-client/classes/ProductVariantsResource", + label: "variants", + } + ] + }, + { + type: "doc", + id: "references/js-client/classes/RegionsResource", + label: "regions", + }, + { + type: "doc", + id: "references/js-client/classes/ReturnReasonsResource", + label: "returnReason", + }, + { + type: "doc", + id: "references/js-client/classes/ReturnsResource", + label: "returns", + }, + { + type: "doc", + id: "references/js-client/classes/ShippingOptionsResource", + label: "shippingOptions", + }, + { + type: "doc", + id: "references/js-client/classes/SwapsResource", + label: "swaps", + }, + ] + } ] } diff --git a/www/docs/src/css/custom.css b/www/docs/src/css/custom.css index 579e5b1c15..c92191e425 100644 --- a/www/docs/src/css/custom.css +++ b/www/docs/src/css/custom.css @@ -204,7 +204,8 @@ a.menu__link.menu__link--active.active { padding-left: 16px; } -a.menu__link--sublist::after { +a.menu__link--sublist::after, +.menu__caret:before { background: var(--ifm-menu-link-sublist-icon) 50% / 1rem 2rem; } diff --git a/yarn.lock b/yarn.lock index 4a4b1c6c0d..c77b8e743a 100644 --- a/yarn.lock +++ b/yarn.lock @@ -27996,6 +27996,15 @@ typedarray@^0.0.6: resolved "https://registry.npmjs.org/typedarray/-/typedarray-0.0.6.tgz" integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c= +"typedoc-frontmatter-plugin@link:docs-util/typedoc-plugins/typedoc-frontmatter-plugin": + version "0.0.0" + uid "" + +typedoc-monorepo-link-types@^0.0.2: + version "0.0.2" + resolved "https://registry.yarnpkg.com/typedoc-monorepo-link-types/-/typedoc-monorepo-link-types-0.0.2.tgz#690d8d6ca219fe96a1ffd42940812936a418d237" + integrity sha512-ez5p1FTiId/Muya6KQPkYGksDhlwO5noo00MJZ1Rrp5ji2MHgfO9g1bHCK4Ygof1cFcI16s0uRvuAj/UR/uxrw== + typedoc-plugin-markdown@^3.12.1: version "3.12.1" resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.12.1.tgz#2a33ca0018bdd7ed512e29960d3eb344ecb65f4a" @@ -28003,6 +28012,16 @@ typedoc-plugin-markdown@^3.12.1: dependencies: handlebars "^4.7.7" +typedoc-plugin-merge-modules@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/typedoc-plugin-merge-modules/-/typedoc-plugin-merge-modules-3.1.0.tgz#60dbdbd2196c1bded8c9f0ff70c59ff34b4b7f80" + integrity sha512-DAHDZD+KG3mRm+hJFAMh/pO98CQ3W/BFA81FzWpc1kos66mLRIa7QVO30yBREkZNZMsTA7fgGEjEN2GO2cgi3A== + +typedoc-plugin-reference-excluder@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/typedoc-plugin-reference-excluder/-/typedoc-plugin-reference-excluder-1.0.0.tgz#a7b03669449249f449c0d4f30024df7acae2088b" + integrity sha512-M09tKr9/9+IWm2jWr2a7gdAuoB0OapfEqxlXt1I1PH8cL0cN0XuZ722oUlx+wYbQOfy5JDE+xza48iDAKYOQew== + typedoc@^0.22.15: version "0.22.15" resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.22.15.tgz#c6ad7ed9d017dc2c3a06c9189cb392bd8e2d8c3f"