docs: fix pricing query params in storefront guide + modules restructure (#9021)

- Fix pricing query params previously using `customer_group_id` and `customer_id` as expected / accepted queries and update information around them - Other: reorganize the introduction page of each module to show how to use it at the very beginning.
2024-09-09 06:43:43 +00:00
parent afb83b2408
commit 3eb2387746
20 changed files with 973 additions and 964 deletions
@@ -8,72 +8,6 @@ export const metadata = {

 The API Key Module is the `@medusajs/api-key` NPM package that provides API-key-related features in your Medusa and Node.js applications.

-## Features
-
-### API Key Types and Management
-
-Store and manage API keys in your store. You can create both publishable and secret API keys for different use cases, such as:
-
- Publishable API Key associated with resources like sales channels.
- Authentication token for admin users to access Admin API Routes.
- Password reset tokens when a user or customer requests to reset their password.
-
-```ts
-const pubApiKey = await apiKeyModuleService.createApiKeys({
-  title: "Publishable API key",
-  type: "publishable",
-  created_by: "user_123",
-})
-
-const secretApiKey = await apiKeyModuleService.createApiKeys({
-  title: "Authentication Key",
-  type: "secret",
-  created_by: "user_123",
-})
-```
-
-### Token Verification
-
-Verify tokens of secret API keys to authenticate users or actions, such as verifying a password reset token.
-
-```ts
-const authenticatedToken = await apiKeyModuleService.authenticate("sk_123")
-
-if (!authenticatedToken) {
-  console.error("Couldn't verify token")
-} else {
-  console.log("Token verified successfully!")
-}
-```
-
-### Revoke Keys
-
-Revoke keys to disable their use permenantly.
-
-```ts
-const revokedKey = await apiKeyModuleService.revoke("apk_1", {
-  revoked_by: "user_123",
-})
-```
-
-### Roll API Keys
-
-Roll API keys by revoking a key then re-creating it.
-
-```ts
-const revokedKey = await apiKeyModuleService.revoke("apk_1", {
-  revoked_by: "user_123",
-})
-
-const newKey = await apiKeyModuleService.createApiKeys({
-  title: revokedKey.title,
-  type: revokedKey.type,
-  created_by: revokedKey.created_by,
-})
-```
-
---
-
 ## How to Use API Key Module's Service

 You can use the API Key Module's main service by resolving from the Medusa container the resource `ModuleRegistrationName.API_KEY` imported from `@medusajs/utils`.
@@ -138,3 +72,69 @@ const step1 = createStep("step-1", async (_, { container }) => {

  </CodeTab>
 </CodeTabs>
+
+---
+
+## Features
+
+### API Key Types and Management
+
+Store and manage API keys in your store. You can create both publishable and secret API keys for different use cases, such as:
+
+- Publishable API Key associated with resources like sales channels.
+- Authentication token for admin users to access Admin API Routes.
+- Password reset tokens when a user or customer requests to reset their password.
+
+```ts
+const pubApiKey = await apiKeyModuleService.createApiKeys({
+  title: "Publishable API key",
+  type: "publishable",
+  created_by: "user_123",
+})
+
+const secretApiKey = await apiKeyModuleService.createApiKeys({
+  title: "Authentication Key",
+  type: "secret",
+  created_by: "user_123",
+})
+```
+
+### Token Verification
+
+Verify tokens of secret API keys to authenticate users or actions, such as verifying a password reset token.
+
+```ts
+const authenticatedToken = await apiKeyModuleService.authenticate("sk_123")
+
+if (!authenticatedToken) {
+  console.error("Couldn't verify token")
+} else {
+  console.log("Token verified successfully!")
+}
+```
+
+### Revoke Keys
+
+Revoke keys to disable their use permenantly.
+
+```ts
+const revokedKey = await apiKeyModuleService.revoke("apk_1", {
+  revoked_by: "user_123",
+})
+```
+
+### Roll API Keys
+
+Roll API keys by revoking a key then re-creating it.
+
+```ts
+const revokedKey = await apiKeyModuleService.revoke("apk_1", {
+  revoked_by: "user_123",
+})
+
+const newKey = await apiKeyModuleService.createApiKeys({
+  title: revokedKey.title,
+  type: revokedKey.type,
+  created_by: revokedKey.created_by,
+})
+```