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

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

docs/api/store/code_samples/JavaScript/auth/getundefined

@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged
+medusa.auth.getSession()
+.then(({ customer }) => {
+  console.log(customer.id);
+});

docs/api/store/code_samples/JavaScript/auth/postundefined

@@ -0,0 +1,9 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.auth.authenticate({
+  email: 'user@example.com',
+  password: 'user@example.com'
+})
+.then(({ customer }) => {
+  console.log(customer.id);
+});

docs/api/store/code_samples/JavaScript/auth_{email}/getundefined

@@ -0,0 +1,3 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.auth.exists('user@example.com')

docs/api/store/code_samples/JavaScript/carts/postundefined

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

docs/api/store/code_samples/JavaScript/carts_{id}/getundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.carts.retrieve(cart_id)
+.then(({ cart }) => {
+  console.log(cart.id);
+});

docs/api/store/code_samples/JavaScript/carts_{id}/postundefined

@@ -0,0 +1,8 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.carts.update(cart_id, {
+  email: 'user@example.com'
+})
+.then(({ cart }) => {
+  console.log(cart.id);
+});

docs/api/store/code_samples/JavaScript/carts_{id}_complete/postundefined

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

docs/api/store/code_samples/JavaScript/carts_{id}_discounts_{code}/deleteundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.carts.deleteDiscount(cart_id, code)
+.then(({ cart }) => {
+  console.log(cart.id);
+});

docs/api/store/code_samples/JavaScript/carts_{id}_line-items/postundefined

@@ -0,0 +1,9 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.carts.lineItems.create(cart_id, {
+  variant_id,
+  quantity: 1
+})
+.then(({ cart }) => {
+  console.log(cart.id);
+});

docs/api/store/code_samples/JavaScript/carts_{id}_line-items_{line_id}/deleteundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.carts.lineItems.delete(cart_id, line_id)
+.then(({ cart }) => {
+  console.log(cart.id);
+});

docs/api/store/code_samples/JavaScript/carts_{id}_line-items_{line_id}/postundefined

@@ -0,0 +1,8 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.carts.lineItems.update(cart_id, line_id, {
+  quantity: 1
+})
+.then(({ cart }) => {
+  console.log(cart.id);
+});

docs/api/store/code_samples/JavaScript/carts_{id}_payment-session/postundefined

@@ -0,0 +1,8 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.carts.setPaymentSession(cart_id, {
+  provider_id: 'manual'
+})
+.then(({ cart }) => {
+  console.log(cart.id);
+});

docs/api/store/code_samples/JavaScript/carts_{id}_payment-sessions/postundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.carts.createPaymentSessions(cart_id)
+.then(({ cart }) => {
+  console.log(cart.id);
+});

docs/api/store/code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}/deleteundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.carts.deletePaymentSession(cart_id, 'manual')
+.then(({ cart }) => {
+  console.log(cart.id);
+});

docs/api/store/code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}/postundefined

@@ -0,0 +1,9 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.carts.updatePaymentSession(cart_id, 'manual', {
+  data: {
+  }
+})
+.then(({ cart }) => {
+  console.log(cart.id);
+});

docs/api/store/code_samples/JavaScript/carts_{id}_payment-sessions_{provider_id}_refresh/postundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.carts.refreshPaymentSession(cart_id, 'manual')
+.then(({ cart }) => {
+  console.log(cart.id);
+});

docs/api/store/code_samples/JavaScript/carts_{id}_shipping-methods/postundefined

@@ -0,0 +1,8 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.carts.addShippingMethod(cart_id, {
+  option_id
+})
+.then(({ cart }) => {
+  console.log(cart.id);
+});

docs/api/store/code_samples/JavaScript/collections/getundefined

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

docs/api/store/code_samples/JavaScript/collections_{id}/getundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.collections.retrieve(collection_id)
+.then(({ collection }) => {
+  console.log(collection.id);
+});

docs/api/store/code_samples/JavaScript/customers/postundefined

@@ -0,0 +1,11 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.customers.create({
+  first_name: 'Alec',
+  last_name: 'Reynolds',
+  email: 'user@example.com',
+  password: 'supersecret'
+})
+.then(({ customer }) => {
+  console.log(customer.id);
+});

docs/api/store/code_samples/JavaScript/customers_me/getundefined

@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged
+medusa.customers.retrieve()
+.then(({ customer }) => {
+  console.log(customer.id);
+});

docs/api/store/code_samples/JavaScript/customers_me/postundefined

@@ -0,0 +1,9 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged
+medusa.customers.update({
+  first_name: 'Laury'
+})
+.then(({ customer }) => {
+  console.log(customer.id);
+});

docs/api/store/code_samples/JavaScript/customers_me_addresses/postundefined

@@ -0,0 +1,21 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged
+medusa.customers.addresses.addAddress({
+  address: {
+    first_name: 'Celia',
+    last_name: 'Schumm',
+    address_1: '225 Bednar Curve',
+    city: 'Danielville',
+    country_code: 'US',
+    postal_code: '85137',
+    phone: '981-596-6748 x90188',
+    company: 'Wyman LLC',
+    address_2: '',
+    province: 'Georgia',
+    metadata: {}
+  }
+})
+.then(({ customer }) => {
+  console.log(customer.id);
+});

docs/api/store/code_samples/JavaScript/customers_me_addresses_{address_id}/deleteundefined

@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged
+medusa.customers.addresses.deleteAddress(address_id)
+.then(({ customer }) => {
+  console.log(customer.id);
+});

docs/api/store/code_samples/JavaScript/customers_me_addresses_{address_id}/postundefined

@@ -0,0 +1,9 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged
+medusa.customers.addresses.updateAddress(address_id, {
+  first_name: 'Gina'
+})
+.then(({ customer }) => {
+  console.log(customer.id);
+});

docs/api/store/code_samples/JavaScript/customers_me_orders/getundefined

@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged
+medusa.customers.listOrders()
+.then(({ orders, limit, offset, count }) => {
+  console.log(orders);
+});

docs/api/store/code_samples/JavaScript/customers_me_payment-methods/getundefined

@@ -0,0 +1,7 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+// must be previously logged
+medusa.customers.paymentMethods.list()
+.then(({ payment_methods }) => {
+  console.log(payment_methods.length);
+});

docs/api/store/code_samples/JavaScript/customers_password-reset/postundefined

@@ -0,0 +1,10 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.customers.resetPassword({
+  email: 'user@example.com',
+  password: 'supersecret',
+  token: 'supersecrettoken'
+})
+.then(({ customer }) => {
+  console.log(customer.id);
+});

docs/api/store/code_samples/JavaScript/customers_password-token/postundefined

@@ -0,0 +1,11 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.customers.generatePasswordToken({
+  email: 'user@example.com'
+})
+.then(() => {
+  // successful
+})
+.catch(() => {
+  // failed
+})

docs/api/store/code_samples/JavaScript/gift-cards_{code}/getundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.giftCards.retrieve(code)
+.then(({ gift_card }) => {
+  console.log(gift_card.id);
+});

docs/api/store/code_samples/JavaScript/orders/getundefined

@@ -0,0 +1,9 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.orders.lookupOrder({
+  display_id: 1,
+  email: 'user@example.com'
+})
+.then(({ order }) => {
+  console.log(order.id);
+});

docs/api/store/code_samples/JavaScript/orders_cart_{cart_id}/getundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.orders.retrieveByCartId(cart_id)
+.then(({ order }) => {
+  console.log(order.id);
+});

docs/api/store/code_samples/JavaScript/orders_{id}/getundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.orders.retrieve(order_id)
+.then(({ order }) => {
+  console.log(order.id);
+});

docs/api/store/code_samples/JavaScript/products/getundefined

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

docs/api/store/code_samples/JavaScript/products_search/postundefined

@@ -0,0 +1,8 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.products.search({
+  q: 'Shirt'
+})
+.then(({ hits }) => {
+  console.log(hits.length);
+});

docs/api/store/code_samples/JavaScript/products_{id}/getundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.products.retrieve(product_id)
+.then(({ product }) => {
+  console.log(product.id);
+});

docs/api/store/code_samples/JavaScript/regions/getundefined

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

docs/api/store/code_samples/JavaScript/regions_{id}/getundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.regions.retrieve(region_id)
+.then(({ region }) => {
+  console.log(region.id);
+});

docs/api/store/code_samples/JavaScript/return-reasons/getundefined

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

docs/api/store/code_samples/JavaScript/return-reasons_{id}/getundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.returnReasons.retrieve(reason_id)
+.then(({ return_reason }) => {
+  console.log(return_reason.id);
+});

docs/api/store/code_samples/JavaScript/returns/postundefined

@@ -0,0 +1,14 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.returns.create({
+  order_id,
+  items: [
+    {
+      item_id,
+      quantity: 1
+    }
+  ]
+})
+.then(({ return }) => {
+  console.log(return.id);
+});

docs/api/store/code_samples/JavaScript/shipping-options/getundefined

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

docs/api/store/code_samples/JavaScript/shipping-options_{cart_id}/getundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.shippingOptions.listCartOptions(cart_id)
+.then(({ shipping_options }) => {
+  console.log(shipping_options.length);
+});

docs/api/store/code_samples/JavaScript/swaps/postundefined

@@ -0,0 +1,20 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.swaps.create({
+  order_id,
+  return_items: [
+    {
+      item_id,
+      quantity: 1
+    }
+  ],
+  additional_items: [
+    {
+      variant_id,
+      quantity: 1
+    }
+  ]
+})
+.then(({ swap }) => {
+  console.log(swap.id);
+});

docs/api/store/code_samples/JavaScript/swaps_{cart_id}/getundefined

@@ -0,0 +1,6 @@
+import Medusa from "@medusajs/medusa-js"
+const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+medusa.swaps.retrieveByCartId(cart_id)
+.then(({ swap }) => {
+  console.log(swap.id);
+});