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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

docs/api/store/code_samples/Shell/store_auth/delete.sh

@@ -1,2 +1,2 @@
-curl --location --request DELETE 'https://medusa-url.com/store/auth' \
---header 'Cookie: connect.sid={sid}'
+curl -X DELETE 'https://medusa-url.com/store/auth' \
+-H 'Cookie: connect.sid={sid}'

docs/api/store/code_samples/Shell/store_auth/get.sh

@@ -1,2 +1,2 @@
-curl --location --request GET 'https://medusa-url.com/store/auth' \
---header 'Cookie: connect.sid={sid}'
+curl 'https://medusa-url.com/store/auth' \
+-H 'Cookie: connect.sid={sid}'

docs/api/store/code_samples/Shell/store_auth/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/auth' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/auth' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "email": "user@example.com",
     "password": "supersecret"

docs/api/store/code_samples/Shell/store_auth_{email}/get.sh

@@ -1,2 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/auth/user@example.com' \
---header 'Cookie: connect.sid={sid}'
+curl 'https://medusa-url.com/store/auth/user@example.com'

docs/api/store/code_samples/Shell/store_carts/post.sh

@@ -1 +1 @@
-curl --location --request POST 'https://medusa-url.com/store/carts'
+curl -X POST 'https://medusa-url.com/store/carts'

docs/api/store/code_samples/Shell/store_carts_{id}/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/carts/{id}'
+curl 'https://medusa-url.com/store/carts/{id}'

docs/api/store/code_samples/Shell/store_carts_{id}/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/carts/{id}' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/carts/{id}' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "email": "user@example.com"
 }'

docs/api/store/code_samples/Shell/store_carts_{id}_complete/post.sh

@@ -1 +1 @@
-curl --location --request POST 'https://medusa-url.com/store/carts/{id}/complete'
+curl -X POST 'https://medusa-url.com/store/carts/{id}/complete'

docs/api/store/code_samples/Shell/store_carts_{id}_discounts_{code}/delete.sh

@@ -1 +1 @@
-curl --location --request DELETE 'https://medusa-url.com/store/carts/{id}/discounts/{code}'
+curl -X DELETE 'https://medusa-url.com/store/carts/{id}/discounts/{code}'

docs/api/store/code_samples/Shell/store_carts_{id}_line-items/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/carts/{id}/line-items' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/carts/{id}/line-items' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "variant_id": "{variant_id}",
     "quantity": 1

docs/api/store/code_samples/Shell/store_carts_{id}_line-items_{line_id}/delete.sh

@@ -1 +1 @@
-curl --location --request DELETE 'https://medusa-url.com/store/carts/{id}/line-items/{line_id}'
+curl -X DELETE 'https://medusa-url.com/store/carts/{id}/line-items/{line_id}'

docs/api/store/code_samples/Shell/store_carts_{id}_line-items_{line_id}/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/carts/{id}/line-items/{line_id}' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/carts/{id}/line-items/{line_id}' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "quantity": 1
 }'

docs/api/store/code_samples/Shell/store_carts_{id}_payment-session/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/carts/{id}/payment-sessions' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/carts/{id}/payment-sessions' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "provider_id": "manual"
 }'

docs/api/store/code_samples/Shell/store_carts_{id}_payment-sessions/post.sh

@@ -1 +1 @@
-curl --location --request POST 'https://medusa-url.com/store/carts/{id}/payment-sessions'
+curl -X POST 'https://medusa-url.com/store/carts/{id}/payment-sessions'

docs/api/store/code_samples/Shell/store_carts_{id}_payment-sessions_{provider_id}/delete.sh

@@ -1 +1 @@
-curl --location --request DELETE 'https://medusa-url.com/store/carts/{id}/payment-sessions/manual'
+curl -X DELETE 'https://medusa-url.com/store/carts/{id}/payment-sessions/{provider_id}'

docs/api/store/code_samples/Shell/store_carts_{id}_payment-sessions_{provider_id}/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/carts/{id}/payment-sessions/manual' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/carts/{id}/payment-sessions/manual' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "data": {}
 }'

docs/api/store/code_samples/Shell/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.sh

@@ -1 +1 @@
-curl --location --request POST 'https://medusa-url.com/store/carts/{id}/payment-sessions/manual/refresh'
+curl -X POST 'https://medusa-url.com/store/carts/{id}/payment-sessions/{provider_id}/refresh'

docs/api/store/code_samples/Shell/store_carts_{id}_shipping-methods/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/carts/{id}/shipping-methods' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/carts/{id}/shipping-methods' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "option_id": "{option_id}",
 }'

docs/api/store/code_samples/Shell/store_carts_{id}_taxes/post.sh

@@ -1 +1 @@
-curl --location --request POST 'https://medusa-url.com/store/carts/{id}/taxes'
+curl -X POST 'https://medusa-url.com/store/carts/{id}/taxes'

docs/api/store/code_samples/Shell/store_collections/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/collections'
+curl 'https://medusa-url.com/store/collections'

docs/api/store/code_samples/Shell/store_collections_{id}/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/collections/{id}'
+curl 'https://medusa-url.com/store/collections/{id}'

docs/api/store/code_samples/Shell/store_customers/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/customers' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/customers' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "first_name": "Alec",
     "last_name": "Reynolds",

docs/api/store/code_samples/Shell/store_customers_me/get.sh

@@ -1,2 +1,2 @@
-curl --location --request GET 'https://medusa-url.com/store/customers/me' \
---header 'Cookie: connect.sid={sid}'
+curl 'https://medusa-url.com/store/customers/me' \
+-H 'Cookie: connect.sid={sid}'

docs/api/store/code_samples/Shell/store_customers_me/post.sh

@@ -1,6 +1,6 @@
-curl --location --request POST 'https://medusa-url.com/store/customers/me' \
---header 'Cookie: connect.sid={sid}' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/customers/me' \
+-H 'Cookie: connect.sid={sid}' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "first_name": "Laury"
 }'

docs/api/store/code_samples/Shell/store_customers_me_addresses/post.sh

@@ -1,6 +1,6 @@
-curl --location --request POST 'https://medusa-url.com/store/customers/me/addresses' \
---header 'Cookie: connect.sid={sid}' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/customers/me/addresses' \
+-H 'Cookie: connect.sid={sid}' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "address": {
       "first_name": "Celia",

docs/api/store/code_samples/Shell/store_customers_me_addresses_{address_id}/delete.sh

@@ -1,2 +1,2 @@
-curl --location --request DELETE 'https://medusa-url.com/store/customers/me/addresses/{address_id}' \
---header 'Cookie: connect.sid={sid}'
+curl -X DELETE 'https://medusa-url.com/store/customers/me/addresses/{address_id}' \
+-H 'Cookie: connect.sid={sid}'

docs/api/store/code_samples/Shell/store_customers_me_addresses_{address_id}/post.sh

@@ -1,6 +1,6 @@
-curl --location --request POST 'https://medusa-url.com/store/customers/me/addresses/{address_id}' \
---header 'Cookie: connect.sid={sid}' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/customers/me/addresses/{address_id}' \
+-H 'Cookie: connect.sid={sid}' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "first_name": "Gina"
 }'

docs/api/store/code_samples/Shell/store_customers_me_orders/get.sh

@@ -1,2 +1,2 @@
-curl --location --request GET 'https://medusa-url.com/store/customers/me/orders' \
---header 'Cookie: connect.sid={sid}'
+curl 'https://medusa-url.com/store/customers/me/orders' \
+-H 'Cookie: connect.sid={sid}'

docs/api/store/code_samples/Shell/store_customers_me_payment-methods/get.sh

@@ -1,2 +1,2 @@
-curl --location --request GET 'https://medusa-url.com/store/customers/me/payment-methods' \
---header 'Cookie: connect.sid={sid}'
+curl 'https://medusa-url.com/store/customers/me/payment-methods' \
+-H 'Cookie: connect.sid={sid}'

docs/api/store/code_samples/Shell/store_customers_password-reset/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/customers/password-reset' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/customers/password-reset' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "email": "user@example.com",
     "password": "supersecret",

docs/api/store/code_samples/Shell/store_customers_password-token/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/customers/password-token' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/customers/password-token' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "email": "user@example.com"
 }'

docs/api/store/code_samples/Shell/store_gift-cards_{code}/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/gift-cards/{code}'
+curl 'https://medusa-url.com/store/gift-cards/{code}'

docs/api/store/code_samples/Shell/store_order-edits_{id}/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/order-edits/{id}'
+curl 'https://medusa-url.com/store/order-edits/{id}'

docs/api/store/code_samples/Shell/store_order-edits_{id}_complete/post.sh

@@ -1 +1 @@
-curl --location --request POST 'https://medusa-url.com/store/order-edits/{id}/complete'
+curl -X POST 'https://medusa-url.com/store/order-edits/{id}/complete'

docs/api/store/code_samples/Shell/store_order-edits_{id}_decline/post.sh

@@ -1 +1 @@
-curl --location --request POST 'https://medusa-url.com/store/order-edits/{id}/decline'
+curl -X POST 'https://medusa-url.com/store/order-edits/{id}/decline'

docs/api/store/code_samples/Shell/store_orders/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/orders?display_id=1&email=user@example.com'
+curl 'https://medusa-url.com/store/orders?display_id=1&email=user@example.com'

docs/api/store/code_samples/Shell/store_orders_batch_customer_token/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/batch/customer/token' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/batch/customer/token' \
+-H 'Content-Type: application/json' \
 --data-raw '{
-    "display_ids": ["id"],
+    "order_ids": ["id"],
 }'

docs/api/store/code_samples/Shell/store_orders_cart_{cart_id}/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/orders/cart/{id}'
+curl 'https://medusa-url.com/store/orders/cart/{cart_id}'

docs/api/store/code_samples/Shell/store_orders_customer_confirm/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/orders/customer/confirm' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/orders/customer/confirm' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "token": "{token}",
 }'

docs/api/store/code_samples/Shell/store_orders_{id}/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/orders/{id}'
+curl 'https://medusa-url.com/store/orders/{id}'

docs/api/store/code_samples/Shell/store_payment-collections_{id}/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/payment-collections/{id}'
+curl 'https://medusa-url.com/store/payment-collections/{id}'

docs/api/store/code_samples/Shell/store_payment-collections_{id}_sessions/post.sh

@@ -1 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/payment-collections/{id}/sessions'
+curl -X POST 'https://medusa-url.com/store/payment-collections/{id}/sessions' \
+-H 'Content-Type: application/json' \
+--data-raw '{
+  "provider_id": "stripe"
+}'

docs/api/store/code_samples/Shell/store_payment-collections_{id}_sessions_batch/post.sh

@@ -1 +1,14 @@
-curl --location --request POST 'https://medusa-url.com/store/payment-collections/{id}/sessions/batch'
+curl -X POST 'https://medusa-url.com/store/payment-collections/{id}/sessions/batch' \
+-H 'Content-Type: application/json' \
+--data-raw '{
+  "sessions": [
+    {
+      "provider_id": "stripe",
+      "amount": 5000
+    },
+    {
+      "provider_id": "manual",
+      "amount": 5000
+    }
+  ]
+}'

docs/api/store/code_samples/Shell/store_payment-collections_{id}_sessions_batch_authorize/post.sh

@@ -1 +1 @@
-curl --location --request POST 'https://medusa-url.com/store/payment-collections/{id}/sessions/batch/authorize'
+curl -X POST 'https://medusa-url.com/store/payment-collections/{id}/sessions/batch/authorize'

docs/api/store/code_samples/Shell/store_payment-collections_{id}_sessions_{session_id}/post.sh

@@ -1 +1 @@
-curl --location --request POST 'https://medusa-url.com/store/payment-collections/{id}/sessions/{session_id}'
+curl -X POST 'https://medusa-url.com/store/payment-collections/{id}/sessions/{session_id}'

docs/api/store/code_samples/Shell/store_payment-collections_{id}_sessions_{session_id}_authorize/post.sh

@@ -1 +1 @@
-curl --location --request POST 'https://medusa-url.com/store/payment-collections/{id}/sessions/{session_id}/authorize'
+curl -X POST 'https://medusa-url.com/store/payment-collections/{id}/sessions/{session_id}/authorize'

docs/api/store/code_samples/Shell/store_product-categories/get.sh

@@ -1,2 +1,2 @@
-curl --location --request GET 'https://medusa-url.com/store/product-categories' \
---header 'Authorization: Bearer {api_token}'
+curl 'https://medusa-url.com/store/product-categories' \
+-H 'Authorization: Bearer {api_token}'

docs/api/store/code_samples/Shell/store_product-categories_{id}/get.sh

@@ -1,2 +1,2 @@
-curl --location --request GET 'https://medusa-url.com/store/product-categories/{id}' \
---header 'Authorization: Bearer {api_token}'
+curl 'https://medusa-url.com/store/product-categories/{id}' \
+-H 'Authorization: Bearer {api_token}'

docs/api/store/code_samples/Shell/store_product-tags/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/product-tags'
+curl 'https://medusa-url.com/store/product-tags'

docs/api/store/code_samples/Shell/store_product-types/get.sh

@@ -1,2 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/product-types' \
---header 'Authorization: Bearer {api_token}'
+curl 'https://medusa-url.com/store/product-types'

docs/api/store/code_samples/Shell/store_products/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/products'
+curl 'https://medusa-url.com/store/products'

docs/api/store/code_samples/Shell/store_products_search/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/products/search' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/products/search' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "q": "Shirt"
 }'

docs/api/store/code_samples/Shell/store_products_{id}/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/products/{id}'
+curl 'https://medusa-url.com/store/products/{id}'

docs/api/store/code_samples/Shell/store_regions/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/regions'
+curl 'https://medusa-url.com/store/regions'

docs/api/store/code_samples/Shell/store_regions_{id}/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/regions/{id}'
+curl 'https://medusa-url.com/store/regions/{id}'

docs/api/store/code_samples/Shell/store_return-reasons/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/return-reasons'
+curl 'https://medusa-url.com/store/return-reasons'

docs/api/store/code_samples/Shell/store_return-reasons_{id}/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/return-reasons/{id}'
+curl 'https://medusa-url.com/store/return-reasons/{id}'

docs/api/store/code_samples/Shell/store_returns/post.sh

@@ -1,5 +1,5 @@
-curl --location --request POST 'https://medusa-url.com/store/returns' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/returns' \
+-H 'Content-Type: application/json' \
 --data-raw '{
     "order_id": "asfasf",
     "items": [

docs/api/store/code_samples/Shell/store_shipping-options/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/shipping-options'
+curl 'https://medusa-url.com/store/shipping-options'

docs/api/store/code_samples/Shell/store_shipping-options_{cart_id}/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/shipping-options/{cart_id}'
+curl 'https://medusa-url.com/store/shipping-options/{cart_id}'

docs/api/store/code_samples/Shell/store_swaps/post.sh

@@ -1,16 +1,16 @@
-curl --location --request POST 'https://medusa-url.com/store/swaps' \
---header 'Content-Type: application/json' \
+curl -X POST 'https://medusa-url.com/store/swaps' \
+-H 'Content-Type: application/json' \
 --data-raw '{
-    "order_id": "asfasf",
+    "order_id": "{order_id}",
     "return_items": [
       {
-        "item_id": "asfas",
+        "item_id": "{item_id}",
         "quantity": 1
       }
     ],
     "additional_items": [
       {
-        "variant_id": "asfas",
+        "variant_id": "{variant_id}",
         "quantity": 1
       }
     ]

docs/api/store/code_samples/Shell/store_swaps_{cart_id}/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/swaps/{cart_id}'
+curl 'https://medusa-url.com/store/swaps/{cart_id}'

docs/api/store/code_samples/Shell/store_variants/get.sh

@@ -1 +1 @@
-curl --location --request GET 'https://medusa-url.com/store/variants'
+curl 'https://medusa-url.com/store/variants'

docs/api/store/code_samples/Shell/store_variants_{id}/get.sh

@@ -0,0 +1 @@
+curl 'https://medusa-url.com/store/variants/{id}'

docs/api/store/code_samples/Shell/store_variants_{variant_id}/get.sh

@@ -1 +0,0 @@
-curl --location --request GET 'https://medusa-url.com/store/variants/{id}'