asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated API reference (#2788)

Browse Source
This commit is contained in:
Shahed Nasser
2022-12-13 12:52:58 +02:00
committed by GitHub
parent a77b4a1b7e
commit 52a8e90aac
413 changed files with 11540 additions and 4501 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/api/admin/code_samples/JavaScript/discounts/postundefined
View File

@@ -9,6 +9,7 @@ medusa.admin.discounts.create({
value: 10,
allocation: AllocationType.ITEM
},
regions: ['reg_XXXXXXXX'],
is_dynamic: false,
is_disabled: false
})

7
docs/api/admin/code_samples/JavaScript/payment-collections_{id}/deleteundefined Normal file
View File

@@ -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.admin.paymentCollections.delete(payment_collection_id)
.then(({ id, object, deleted }) => {
console.log(id)
})

7
docs/api/admin/code_samples/JavaScript/payment-collections_{id}/getundefined Normal file
View File

@@ -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.admin.paymentCollections.retrieve(paymentCollectionId)
.then(({ payment_collection }) => {
console.log(payment_collection.id)
})

9
docs/api/admin/code_samples/JavaScript/payment-collections_{id}/postundefined Normal file
View File

@@ -0,0 +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.paymentCollections.update(payment_collection_id, {
description: "Description of payCol"
})
.then(({ payment_collection }) => {
console.log(payment_collection.id)
})

7
docs/api/admin/code_samples/JavaScript/payment-collections_{id}_authorize/postundefined Normal file
View File

@@ -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.admin.paymentCollections.markAsAuthorized(payment_collection_id)
.then(({ payment_collection }) => {
console.log(payment_collection.id)
})

7
docs/api/admin/code_samples/JavaScript/payments_{id}/getundefined Normal file
View File

@@ -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.admin.payments.retrieve(payment_id)
.then(({ payment }) => {
console.log(payment.id);
});

7
docs/api/admin/code_samples/JavaScript/payments_{id}_capture/postundefined Normal file
View File

@@ -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.admin.payments.capturePayment(payment_id)
.then(({ payment }) => {
console.log(payment.id);
});

11
docs/api/admin/code_samples/JavaScript/payments_{id}_refund/postundefined Normal file
View File

@@ -0,0 +1,11 @@
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.payments.refundPayment(payment_id, {
amount: 1000,
reason: 'return',
note: 'Do not like it',
})
.then(({ payment }) => {
console.log(payment.id);
});

9
docs/api/admin/code_samples/JavaScript/publishable-api-key_{id}/postundefined Normal file
View File

@@ -0,0 +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, {
title: "new title"
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})

7
docs/api/admin/code_samples/JavaScript/publishable-api-keys/getundefined Normal file
View File

@@ -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.admin.publishableApiKeys.list()
.then(({ publishable_api_keys }) => {
console.log(publishable_api_keys)
})

7
docs/api/admin/code_samples/JavaScript/publishable-api-keys/postundefined Normal file
View File

@@ -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.admin.publishableApiKey.create()
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})

7
docs/api/admin/code_samples/JavaScript/publishable-api-keys_:id_sales-channels/getundefined Normal file
View File

@@ -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.admin.publishableApiKeys.listSalesChannels()
.then(({ sales_channels, limit, offset, count }) => {
console.log(sales_channels)
})

7
docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/deleteundefined Normal file
View File

@@ -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.admin.publishableApiKey.delete(key_id)
.then(({ id, object, deleted }) => {
console.log(id)
})

7
docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}/getundefined Normal file
View File

@@ -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.admin.publishableApiKey.retrieve(pubKeyId)
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})

7
docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_revoke/postundefined Normal file
View File

@@ -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.admin.publishableApiKey.revoke()
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})

13
docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/deleteundefined Normal file
View File

@@ -0,0 +1,13 @@
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, {
sales_channel_ids: [
{
id: channel_id
}
]
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id);
});

13
docs/api/admin/code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/postundefined Normal file
View File

@@ -0,0 +1,13 @@
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, {
sales_channel_ids: [
{
id: channel_id
}
]
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id);
});

3
docs/api/admin/code_samples/Shell/discounts/postundefined
View File

@@ -7,5 +7,6 @@ curl --location --request POST 'https://medusa-url.com/admin/discounts' \
"type": "fixed",
"value": 10,
"allocation": "item"
}
},
"regions": ['reg_XXXXXXXX']
}'

2
docs/api/admin/code_samples/Shell/payment-collections_{id}/deleteundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request DELETE 'https://medusa-url.com/admin/payment-collections/{id}' \
--header 'Authorization: Bearer {api_token}'

2
docs/api/admin/code_samples/Shell/payment-collections_{id}/getundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request GET 'https://medusa-url.com/admin/payment-collections/{id}' \
--header 'Authorization: Bearer {api_token}'

6
docs/api/admin/code_samples/Shell/payment-collections_{id}/postundefined Normal file
View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/payment-collections/{id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"description": "Description of payCol"
}'

2
docs/api/admin/code_samples/Shell/payment-collections_{id}_authorize/postundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request POST 'https://medusa-url.com/admin/payment-collections/{id}/authorize' \
--header 'Authorization: Bearer {api_token}'

2
docs/api/admin/code_samples/Shell/payments_{id}/getundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request GET 'https://medusa-url.com/admin/payments/{id}' \
--header 'Authorization: Bearer {api_token}'

2
docs/api/admin/code_samples/Shell/payments_{id}_capture/postundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request POST 'https://medusa-url.com/admin/payments/{id}/capture' \
--header 'Authorization: Bearer {api_token}'

8
docs/api/admin/code_samples/Shell/payments_{id}_refund/postundefined Normal file
View File

@@ -0,0 +1,8 @@
curl --location --request POST 'https://medusa-url.com/admin/payments/pay_123/refund' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 1000,
"reason": "return",
"note": "Do not like it"
}'

6
docs/api/admin/code_samples/Shell/publishable-api-key_{id}/postundefined Normal file
View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/publishable-api-key/{id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "updated title"
}'

2
docs/api/admin/code_samples/Shell/publishable-api-keys/getundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys' \
--header 'Authorization: Bearer {api_token}'

3
docs/api/admin/code_samples/Shell/publishable-api-keys/postundefined Normal file
View File

@@ -0,0 +1,3 @@
curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys' \
--header 'Authorization: Bearer {api_token}'
-d '{ "created_by": "user_123" }'

2
docs/api/admin/code_samples/Shell/publishable-api-keys_:id_sales-channels/getundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/pk_123/sales-channels' \
--header 'Authorization: Bearer {api_token}'

2
docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/deleteundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-key/{id}' \
--header 'Authorization: Bearer {api_token}'

3
docs/api/admin/code_samples/Shell/publishable-api-keys_{id}/getundefined Normal file
View File

@@ -0,0 +1,3 @@
curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/pubkey_123' \
--header 'Authorization: Bearer {api_token}'
-d '{ "created_by": "user_123" }'

3
docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_revoke/postundefined Normal file
View File

@@ -0,0 +1,3 @@
curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/pubkey_123/revoke' \
--header 'Authorization: Bearer {api_token}'
-d '{ "created_by": "user_123", "revoked_by": "user_123" }'

10
docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/deleteundefined Normal file
View File

@@ -0,0 +1,10 @@
curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"sales_channel_ids": [
{
"id": "{sales_channel_id}"
}
]
}'

10
docs/api/admin/code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/postundefined Normal file
View File

@@ -0,0 +1,10 @@
curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"sales_channel_ids": [
{
"id": "{sales_channel_id}"
}
]
}'