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

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2023-01-11 17:43:03 +02:00
parent f20cdeb680
commit 3b632c5130
19 changed files with 121 additions and 106 deletions
--- a/docs/api/admin-spec3.json
+++ b/docs/api/admin-spec3.json
@@ -12314,7 +12314,7 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKeys.addSalesChannels(publishableApiKeyId,
+            medusa.admin.publishableApiKeys.addSalesChannelsBatch(publishableApiKeyId,
            {
              sales_channel_ids: [
                {
@@ -12330,7 +12330,7 @@ paths:
          label: cURL
          source: >
            curl --location --request POST
-            'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
+            'https://medusa-url.com/admin/publishable-api-keys/{pak_id}/batch' \

            --header 'Authorization: Bearer {api_token}' \

@@ -12398,7 +12398,7 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKeys.removeSalesChannels(publishableApiKeyId,
+            medusa.admin.publishableApiKeys.deleteSalesChannelsBatch(publishableApiKeyId,
            {
              sales_channel_ids: [
                {
@@ -12414,7 +12414,7 @@ paths:
          label: cURL
          source: >
            curl --location --request DELETE
-            'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
+            'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/batch' \

            --header 'Authorization: Bearer {api_token}' \

@@ -12475,19 +12475,26 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKey.create()
-              .then(({ publishable_api_key }) => {
-                console.log(publishable_api_key.id)
-              })
+            medusa.admin.publishableApiKeys.create({
+             title
+            })
+
+            .then(({ publishable_api_key }) => {
+              console.log(publishable_api_key.id)
+            })
        - lang: Shell
          label: cURL
          source: >
            curl --location --request POST
            'https://medusa-url.com/admin/publishable-api-keys' \

-            --header 'Authorization: Bearer {api_token}'
+            --header 'Authorization: Bearer {api_token}' \

-            -d '{ "created_by": "user_123" }'
+            --header 'Content-Type: application/json' \
+
+            --data-raw '{
+                "title": "Web API Key"
+            }'
      security:
        - api_token: []
        - cookie_auth: []
@@ -12560,7 +12567,7 @@ paths:
            // must be previously logged in or use api token

            medusa.admin.publishableApiKeys.list()
-              .then(({ publishable_api_keys }) => {
+              .then(({ publishable_api_keys, count, limit, offset }) => {
                console.log(publishable_api_keys)
              })
        - lang: Shell
@@ -12622,15 +12629,16 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKey.delete(key_id)
-              .then(({ id, object, deleted }) => {
-                console.log(id)
-              })
+            medusa.admin.publishableApiKeys.delete(publishableApiKeyId)
+
+            .then(({ id, object, deleted }) => {
+              console.log(id)
+            })
        - lang: Shell
          label: cURL
          source: >
            curl --location --request DELETE
-            'https://medusa-url.com/admin/publishable-api-key/{id}' \
+            'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \

            --header 'Authorization: Bearer {api_token}'
      security:
@@ -12682,19 +12690,18 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKey.retrieve(pubKeyId)
-              .then(({ publishable_api_key }) => {
-                console.log(publishable_api_key.id)
-              })
+            medusa.admin.publishableApiKeys.retrieve(publishableApiKeyId)
+
+            .then(({ publishable_api_key }) => {
+              console.log(publishable_api_key.id)
+            })
        - lang: Shell
          label: cURL
          source: >
            curl --location --request GET
-            'https://medusa-url.com/admin/publishable-api-keys/pubkey_123' \
+            'https://medusa-url.com/admin/publishable-api-keys/{pka_id}' \

            --header 'Authorization: Bearer {api_token}'
-
-            -d '{ "created_by": "user_123" }'
      security:
        - api_token: []
        - cookie_auth: []
@@ -12752,14 +12759,14 @@ paths:
            // must be previously logged in or use api token

            medusa.admin.publishableApiKeys.listSalesChannels()
-              .then(({ sales_channels, limit, offset, count }) => {
-                console.log(sales_channels)
+              .then(({ sales_channels }) => {
+                console.log(sales_channels.length)
              })
        - lang: Shell
          label: cURL
          source: >
            curl --location --request GET
-            'https://medusa-url.com/admin/publishable-api-keys/pk_123/sales-channels'
+            'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/sales-channels'
            \

            --header 'Authorization: Bearer {api_token}'
@@ -12815,7 +12822,7 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKey.revoke()
+            medusa.admin.publishableApiKeys.revoke(publishableApiKeyId)
              .then(({ publishable_api_key }) => {
                console.log(publishable_api_key.id)
              })
@@ -12823,12 +12830,10 @@ paths:
          label: cURL
          source: >
            curl --location --request POST
-            'https://medusa-url.com/admin/publishable-api-keys/pubkey_123/revoke'
+            'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/revoke'
            \

            --header 'Authorization: Bearer {api_token}'
-
-            -d '{ "created_by": "user_123", "revoked_by": "user_123" }'
      security:
        - api_token: []
        - cookie_auth: []
@@ -12886,24 +12891,25 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKey.update(publishable_key_id, {
+            medusa.admin.publishableApiKeys.update(publishableApiKeyId, {
              title: "new title"
            })
-              .then(({ publishable_api_key }) => {
-                console.log(publishable_api_key.id)
-              })
+
+            .then(({ publishable_api_key }) => {
+              console.log(publishable_api_key.id)
+            })
        - lang: Shell
          label: cURL
          source: >
            curl --location --request POST
-            'https://medusa-url.com/admin/publishable-api-key/{id}' \
+            'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \

            --header 'Authorization: Bearer {api_token}' \

            --header 'Content-Type: application/json' \

            --data-raw '{
-                "title": "updated title"
+                "title": "new title"
            }'
      security:
        - api_token: []
--- a/docs/api/admin-spec3.yaml
+++ b/docs/api/admin-spec3.yaml
@@ -12314,7 +12314,7 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKeys.addSalesChannels(publishableApiKeyId,
+            medusa.admin.publishableApiKeys.addSalesChannelsBatch(publishableApiKeyId,
            {
              sales_channel_ids: [
                {
@@ -12330,7 +12330,7 @@ paths:
          label: cURL
          source: >
            curl --location --request POST
-            'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
+            'https://medusa-url.com/admin/publishable-api-keys/{pak_id}/batch' \

            --header 'Authorization: Bearer {api_token}' \

@@ -12398,7 +12398,7 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKeys.removeSalesChannels(publishableApiKeyId,
+            medusa.admin.publishableApiKeys.deleteSalesChannelsBatch(publishableApiKeyId,
            {
              sales_channel_ids: [
                {
@@ -12414,7 +12414,7 @@ paths:
          label: cURL
          source: >
            curl --location --request DELETE
-            'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
+            'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/batch' \

            --header 'Authorization: Bearer {api_token}' \

@@ -12475,19 +12475,26 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKey.create()
-              .then(({ publishable_api_key }) => {
-                console.log(publishable_api_key.id)
-              })
+            medusa.admin.publishableApiKeys.create({
+             title
+            })
+
+            .then(({ publishable_api_key }) => {
+              console.log(publishable_api_key.id)
+            })
        - lang: Shell
          label: cURL
          source: >
            curl --location --request POST
            'https://medusa-url.com/admin/publishable-api-keys' \

-            --header 'Authorization: Bearer {api_token}'
+            --header 'Authorization: Bearer {api_token}' \

-            -d '{ "created_by": "user_123" }'
+            --header 'Content-Type: application/json' \
+
+            --data-raw '{
+                "title": "Web API Key"
+            }'
      security:
        - api_token: []
        - cookie_auth: []
@@ -12560,7 +12567,7 @@ paths:
            // must be previously logged in or use api token

            medusa.admin.publishableApiKeys.list()
-              .then(({ publishable_api_keys }) => {
+              .then(({ publishable_api_keys, count, limit, offset }) => {
                console.log(publishable_api_keys)
              })
        - lang: Shell
@@ -12622,15 +12629,16 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKey.delete(key_id)
-              .then(({ id, object, deleted }) => {
-                console.log(id)
-              })
+            medusa.admin.publishableApiKeys.delete(publishableApiKeyId)
+
+            .then(({ id, object, deleted }) => {
+              console.log(id)
+            })
        - lang: Shell
          label: cURL
          source: >
            curl --location --request DELETE
-            'https://medusa-url.com/admin/publishable-api-key/{id}' \
+            'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \

            --header 'Authorization: Bearer {api_token}'
      security:
@@ -12682,19 +12690,18 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKey.retrieve(pubKeyId)
-              .then(({ publishable_api_key }) => {
-                console.log(publishable_api_key.id)
-              })
+            medusa.admin.publishableApiKeys.retrieve(publishableApiKeyId)
+
+            .then(({ publishable_api_key }) => {
+              console.log(publishable_api_key.id)
+            })
        - lang: Shell
          label: cURL
          source: >
            curl --location --request GET
-            'https://medusa-url.com/admin/publishable-api-keys/pubkey_123' \
+            'https://medusa-url.com/admin/publishable-api-keys/{pka_id}' \

            --header 'Authorization: Bearer {api_token}'
-
-            -d '{ "created_by": "user_123" }'
      security:
        - api_token: []
        - cookie_auth: []
@@ -12752,14 +12759,14 @@ paths:
            // must be previously logged in or use api token

            medusa.admin.publishableApiKeys.listSalesChannels()
-              .then(({ sales_channels, limit, offset, count }) => {
-                console.log(sales_channels)
+              .then(({ sales_channels }) => {
+                console.log(sales_channels.length)
              })
        - lang: Shell
          label: cURL
          source: >
            curl --location --request GET
-            'https://medusa-url.com/admin/publishable-api-keys/pk_123/sales-channels'
+            'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/sales-channels'
            \

            --header 'Authorization: Bearer {api_token}'
@@ -12815,7 +12822,7 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKey.revoke()
+            medusa.admin.publishableApiKeys.revoke(publishableApiKeyId)
              .then(({ publishable_api_key }) => {
                console.log(publishable_api_key.id)
              })
@@ -12823,12 +12830,10 @@ paths:
          label: cURL
          source: >
            curl --location --request POST
-            'https://medusa-url.com/admin/publishable-api-keys/pubkey_123/revoke'
+            'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/revoke'
            \

            --header 'Authorization: Bearer {api_token}'
-
-            -d '{ "created_by": "user_123", "revoked_by": "user_123" }'
      security:
        - api_token: []
        - cookie_auth: []
@@ -12886,24 +12891,25 @@ paths:

            // must be previously logged in or use api token

-            medusa.admin.publishableApiKey.update(publishable_key_id, {
+            medusa.admin.publishableApiKeys.update(publishableApiKeyId, {
              title: "new title"
            })
-              .then(({ publishable_api_key }) => {
-                console.log(publishable_api_key.id)
-              })
+
+            .then(({ publishable_api_key }) => {
+              console.log(publishable_api_key.id)
+            })
        - lang: Shell
          label: cURL
          source: >
            curl --location --request POST
-            'https://medusa-url.com/admin/publishable-api-key/{id}' \
+            'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \

            --header 'Authorization: Bearer {api_token}' \

            --header 'Content-Type: application/json' \

            --data-raw '{
-                "title": "updated title"
+                "title": "new title"
            }'
      security:
        - api_token: []
--- a/docs/api/admin/code_samples/JavaScript/publishable-api-key_{id}/postundefined
+++ b/docs/api/admin/code_samples/JavaScript/publishable-api-key_{id}/postundefined
@@ -1,9 +1,9 @@
 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.admin.publishableApiKey.update(publishable_key_id, {
+medusa.admin.publishableApiKeys.update(publishableApiKeyId, {
  title: "new title"
 })
-  .then(({ publishable_api_key }) => {
-    console.log(publishable_api_key.id)
-  })
+.then(({ publishable_api_key }) => {
+  console.log(publishable_api_key.id)
+})
--- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys/getundefined
+++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys/getundefined
@@ -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.admin.publishableApiKeys.list()
-  .then(({ publishable_api_keys }) => {
+  .then(({ publishable_api_keys, count, limit, offset }) => {
    console.log(publishable_api_keys)
  })
--- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys/postundefined
+++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys/postundefined
@@ -1,7 +1,9 @@
 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.admin.publishableApiKey.create()
-  .then(({ publishable_api_key }) => {
-    console.log(publishable_api_key.id)
-  })
+medusa.admin.publishableApiKeys.create({
+ title
+})
+.then(({ publishable_api_key }) => {
+  console.log(publishable_api_key.id)
+})
--- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/deleteundefined
+++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/deleteundefined
@@ -1,7 +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.admin.publishableApiKey.delete(key_id)
-  .then(({ id, object, deleted }) => {
-    console.log(id)
-  })
+medusa.admin.publishableApiKeys.delete(publishableApiKeyId)
+.then(({ id, object, deleted }) => {
+  console.log(id)
+})
--- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/getundefined
+++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/getundefined
@@ -1,7 +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.admin.publishableApiKey.retrieve(pubKeyId)
-  .then(({ publishable_api_key }) => {
-    console.log(publishable_api_key.id)
-  })
+medusa.admin.publishableApiKeys.retrieve(publishableApiKeyId)
+.then(({ publishable_api_key }) => {
+  console.log(publishable_api_key.id)
+})
--- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_revoke/postundefined
+++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_revoke/postundefined
@@ -1,7 +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.admin.publishableApiKey.revoke()
+medusa.admin.publishableApiKeys.revoke(publishableApiKeyId)
  .then(({ publishable_api_key }) => {
    console.log(publishable_api_key.id)
  })
--- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels/getundefined
+++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels/getundefined
@@ -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.admin.publishableApiKeys.listSalesChannels()
-  .then(({ sales_channels, limit, offset, count }) => {
-    console.log(sales_channels)
+  .then(({ sales_channels }) => {
+    console.log(sales_channels.length)
  })
--- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/deleteundefined
+++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/deleteundefined
@@ -1,7 +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.admin.publishableApiKeys.removeSalesChannels(publishableApiKeyId, {
+medusa.admin.publishableApiKeys.deleteSalesChannelsBatch(publishableApiKeyId, {
  sales_channel_ids: [
    {
      id: channel_id
--- a/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/postundefined
+++ b/docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/postundefined
@@ -1,7 +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.admin.publishableApiKeys.addSalesChannels(publishableApiKeyId, {
+medusa.admin.publishableApiKeys.addSalesChannelsBatch(publishableApiKeyId, {
  sales_channel_ids: [
    {
      id: channel_id
--- a/docs/api/admin/code_samples/Shell/publishable-api-key_{id}/postundefined
+++ b/docs/api/admin/code_samples/Shell/publishable-api-key_{id}/postundefined
@@ -1,6 +1,6 @@
-curl --location --request POST 'https://medusa-url.com/admin/publishable-api-key/{id}' \
+curl --location --request POST 'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \
 --header 'Authorization: Bearer {api_token}' \
 --header 'Content-Type: application/json' \
 --data-raw '{
-    "title": "updated title"
+    "title": "new title"
 }'
--- a/docs/api/admin/code_samples/Shell/publishable-api-keys/postundefined
+++ b/docs/api/admin/code_samples/Shell/publishable-api-keys/postundefined
@@ -1,3 +1,6 @@
 curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys' \
--header 'Authorization: Bearer {api_token}'
-d '{ "created_by": "user_123" }'
+--header 'Authorization: Bearer {api_token}' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "title": "Web API Key"
+}'
--- a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/deleteundefined
+++ b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/deleteundefined
@@ -1,2 +1,2 @@
-curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-key/{id}' \
+curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \
 --header 'Authorization: Bearer {api_token}'
--- a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/getundefined
+++ b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/getundefined
@@ -1,3 +1,2 @@
-curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/pubkey_123' \
+curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}' \
 --header 'Authorization: Bearer {api_token}'
-d '{ "created_by": "user_123" }'
--- a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_revoke/postundefined
+++ b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_revoke/postundefined
@@ -1,3 +1,2 @@
-curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/pubkey_123/revoke' \
+curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/revoke' \
 --header 'Authorization: Bearer {api_token}'
-d '{ "created_by": "user_123", "revoked_by": "user_123" }'
--- a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels/getundefined
+++ b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels/getundefined
@@ -1,2 +1,2 @@
-curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/pk_123/sales-channels' \
+curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/sales-channels' \
 --header 'Authorization: Bearer {api_token}'
--- a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/deleteundefined
+++ b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/deleteundefined
@@ -1,4 +1,4 @@
-curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
+curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/batch' \
 --header 'Authorization: Bearer {api_token}' \
 --header 'Content-Type: application/json' \
 --data-raw '{
--- a/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/postundefined
+++ b/docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/postundefined
@@ -1,4 +1,4 @@
-curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
+curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/{pak_id}/batch' \
 --header 'Authorization: Bearer {api_token}' \
 --header 'Content-Type: application/json' \
 --data-raw '{