chore(docs): Generated API Reference (#5601)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/delete.js

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.auth.deleteSession()
+.then(() => {
+  // customer logged out successfully
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/get.js

@@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.auth.getSession()
 .then(({ customer }) => {
   console.log(customer.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/post.js

@@ -6,4 +6,4 @@ medusa.auth.authenticate({
 })
 .then(({ customer }) => {
   console.log(customer.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth_token/post.js

@@ -6,4 +6,4 @@ medusa.auth.getToken({
 })
 .then(({ access_token }) => {
   console.log(access_token);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts/post.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.carts.create()
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.carts.retrieve(cartId)
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}/post.js

@@ -5,4 +5,4 @@ medusa.carts.update(cartId, {
 })
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_complete/post.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.carts.complete(cartId)
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_discounts_{code}/delete.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.carts.deleteDiscount(cartId, code)
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items/post.js

@@ -6,4 +6,4 @@ medusa.carts.lineItems.create(cart_id, {
 })
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/delete.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.carts.lineItems.delete(cartId, lineId)
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/post.js

@@ -5,4 +5,4 @@ medusa.carts.lineItems.update(cartId, lineId, {
 })
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-session/post.js

@@ -5,4 +5,4 @@ medusa.carts.setPaymentSession(cartId, {
 })
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions/post.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.carts.createPaymentSessions(cartId)
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/delete.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.carts.deletePaymentSession(cartId, "manual")
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/post.js

@@ -7,4 +7,4 @@ medusa.carts.updatePaymentSession(cartId, "manual", {
 })
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.carts.refreshPaymentSession(cartId, "manual")
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_shipping-methods/post.js

@@ -5,4 +5,4 @@ medusa.carts.addShippingMethod(cartId, {
 })
 .then(({ cart }) => {
   console.log(cart.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_collections/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.collections.list()
 .then(({ collections, limit, offset, count }) => {
   console.log(collections.length);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_collections_{id}/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.collections.retrieve(collectionId)
 .then(({ collection }) => {
   console.log(collection.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers/post.js

@@ -8,4 +8,4 @@ medusa.customers.create({
 })
 .then(({ customer }) => {
   console.log(customer.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me/get.js

@@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.customers.retrieve()
 .then(({ customer }) => {
   console.log(customer.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me/post.js

@@ -6,4 +6,4 @@ medusa.customers.update({
 })
 .then(({ customer }) => {
   console.log(customer.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses/post.js

@@ -16,4 +16,4 @@ medusa.customers.addresses.addAddress({
 })
 .then(({ customer }) => {
   console.log(customer.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses_{address_id}/delete.js

@@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.customers.addresses.deleteAddress(addressId)
 .then(({ customer }) => {
   console.log(customer.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses_{address_id}/post.js

@@ -6,4 +6,4 @@ medusa.customers.addresses.updateAddress(addressId, {
 })
 .then(({ customer }) => {
   console.log(customer.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_orders/get.js

@@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.customers.listOrders()
 .then(({ orders, limit, offset, count }) => {
   console.log(orders);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_payment-methods/get.js

@@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.customers.paymentMethods.list()
 .then(({ payment_methods }) => {
   console.log(payment_methods.length);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_password-reset/post.js

@@ -7,4 +7,4 @@ medusa.customers.resetPassword({
 })
 .then(({ customer }) => {
   console.log(customer.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_gift-cards_{code}/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.giftCards.retrieve(code)
 .then(({ gift_card }) => {
   console.log(gift_card.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.orderEdits.retrieve(orderEditId)
 .then(({ order_edit }) => {
   console.log(order_edit.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}_complete/post.js

@@ -1,6 +1,6 @@
 import Medusa from "@medusajs/medusa-js"
 const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.orderEdits.complete(orderEditId)
-  .then(({ order_edit }) => {
-    console.log(order_edit.id)
-  })
+.then(({ order_edit }) => {
+  console.log(order_edit.id)
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}_decline/post.js

@@ -1,6 +1,6 @@
 import Medusa from "@medusajs/medusa-js"
 const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.orderEdits.decline(orderEditId)
-  .then(({ order_edit }) => {
-    console.log(order_edit.id);
-  })
+.then(({ order_edit }) => {
+  console.log(order_edit.id);
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders/get.js

@@ -6,4 +6,4 @@ medusa.orders.lookupOrder({
 })
 .then(({ order }) => {
   console.log(order.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_batch_customer_token/post.js

@@ -9,4 +9,4 @@ medusa.orders.requestCustomerOrders({
 })
 .catch(() => {
   // an error occurred
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_cart_{cart_id}/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.orders.retrieveByCartId(cartId)
 .then(({ order }) => {
   console.log(order.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_customer_confirm/post.js

@@ -9,4 +9,4 @@ medusa.orders.confirmRequest(
 })
 .catch(() => {
   // an error occurred
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_{id}/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.orders.retrieve(orderId)
 .then(({ order }) => {
   console.log(order.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}/get.js

@@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js"
 const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 // must be previously logged in or use api token
 medusa.paymentCollections.retrieve(paymentCollectionId)
-  .then(({ payment_collection }) => {
-    console.log(payment_collection.id)
-  })
+.then(({ payment_collection }) => {
+  console.log(payment_collection.id)
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions/post.js

@@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.paymentCollections.managePaymentSession(payment_id, { provider_id: "stripe" })
 .then(({ payment_collection }) => {
   console.log(payment_collection.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_batch/post.js

@@ -19,7 +19,7 @@ medusa.paymentCollections.managePaymentSessionsBatch(paymentId, {
 })
 .then(({ payment_collection }) => {
   console.log(payment_collection.id);
-});
+})
 
 // Example 2: Updating one session and removing the other
 medusa.paymentCollections.managePaymentSessionsBatch(paymentId, {
@@ -33,4 +33,4 @@ medusa.paymentCollections.managePaymentSessionsBatch(paymentId, {
 })
 .then(({ payment_collection }) => {
   console.log(payment_collection.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_batch_authorize/post.js

@@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.paymentCollections.authorize(paymentId)
 .then(({ payment_collection }) => {
   console.log(payment_collection.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}/post.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.paymentCollections.refreshPaymentSession(paymentCollectionId, sessionId)
 .then(({ payment_session }) => {
   console.log(payment_session.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}_authorize/post.js

@@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.paymentCollections.authorize(paymentId, sessionId)
 .then(({ payment_collection }) => {
   console.log(payment_collection.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-categories/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.productCategories.list()
 .then(({ product_categories, limit, offset, count }) => {
   console.log(product_categories.length);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-categories_{id}/get.js

@@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js"
 const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 // must be previously logged in or use api token
 medusa.productCategories.retrieve(productCategoryId)
-  .then(({ product_category }) => {
-    console.log(product_category.id);
-  });
+.then(({ product_category }) => {
+  console.log(product_category.id);
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-tags/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.productTags.list()
 .then(({ product_tags }) => {
   console.log(product_tags.length);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-types/get.js

@@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.productTypes.list()
 .then(({ product_types }) => {
   console.log(product_types.length);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_products/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.products.list()
 .then(({ products, limit, offset, count }) => {
   console.log(products.length);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_products_search/post.js

@@ -5,4 +5,4 @@ medusa.products.search({
 })
 .then(({ hits }) => {
   console.log(hits.length);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_products_{id}/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.products.retrieve(productId)
 .then(({ product }) => {
   console.log(product.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_regions/get.js

@@ -1,6 +1,6 @@
 import Medusa from "@medusajs/medusa-js"
 const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.regions.list()
-.then(({ regions }) => {
+.then(({ regions, count, limit, offset }) => {
   console.log(regions.length);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_regions_{id}/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.regions.retrieve(regionId)
 .then(({ region }) => {
   console.log(region.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_return-reasons/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.returnReasons.list()
 .then(({ return_reasons }) => {
   console.log(return_reasons.length);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_return-reasons_{id}/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.returnReasons.retrieve(reasonId)
 .then(({ return_reason }) => {
   console.log(return_reason.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_returns/post.js

@@ -11,4 +11,4 @@ medusa.returns.create({
 })
 .then((data) => {
   console.log(data.return.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_shipping-options/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.shippingOptions.list()
 .then(({ shipping_options }) => {
   console.log(shipping_options.length);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_shipping-options_{cart_id}/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.shippingOptions.listCartOptions(cartId)
 .then(({ shipping_options }) => {
   console.log(shipping_options.length);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_swaps/post.js

@@ -17,4 +17,4 @@ medusa.swaps.create({
 })
 .then(({ swap }) => {
   console.log(swap.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_swaps_{cart_id}/get.js

@@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
 medusa.swaps.retrieveByCartId(cartId)
 .then(({ swap }) => {
   console.log(swap.id);
-});
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_variants/get.js

@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.product.variants.list()
+.then(({ variants }) => {
+  console.log(variants.length);
+})

www/apps/api-reference/specs/store/code_samples/JavaScript/store_variants_{id}/get.js

@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged in or use api token
+medusa.product.variants.retrieve(productVariantId)
+.then(({ variant }) => {
+  console.log(variant.id);
+})