docs: add loyalty plugin routes to OAS

packages/cli/oas/medusa-oas-cli/redocly/redocly-config.yaml

@@ -141,6 +141,14 @@ decorators:
         - Order
       AdminProductVariantInventoryItemLink:
         - AdminProductVariant
+      AdminGiftCardInvitation:
+        - AdminGiftCard
+      AdminTransactionGroup:
+        - AdminStoreCreditAccount
+      StoreGiftCard:
+        - StoreGiftCardInvitation
+      StoreTransactionGroup:
+        - StoreStoreCreditAccount
 theme:
   openapi:
     theme:

www/apps/api-reference/components/Tags/Operation/DescriptionSection/index.tsx

@@ -8,7 +8,15 @@ import dynamic from "next/dynamic"
 import TagsOperationDescriptionSectionParameters from "./Parameters"
 import MDXContentClient from "@/components/MDXContent/Client"
 import { useArea } from "../../../../providers/area"
-import { Feedback, Badge, Link, FeatureFlagNotice, H2, Tooltip } from "docs-ui"
+import {
+  Feedback,
+  Badge,
+  Link,
+  FeatureFlagNotice,
+  H2,
+  Tooltip,
+  MarkdownContent,
+} from "docs-ui"
 import { usePathname } from "next/navigation"
 import { TagsOperationDescriptionSectionWorkflowBadgeProps } from "./WorkflowBadge"
 import { TagsOperationDescriptionSectionEventsProps } from "./Events"
@@ -79,6 +87,24 @@ const TagsOperationDescriptionSection = ({
             </Badge>
           </Tooltip>
         )}
+        {operation["x-badges"]?.map((badge, index) => (
+          <Tooltip
+            key={index}
+            tooltipChildren={
+              <MarkdownContent
+                allowedElements={["a", "strong", "em", "br"]}
+                unwrapDisallowed={true}
+              >
+                {badge.description}
+              </MarkdownContent>
+            }
+            clickable={true}
+          >
+            <Badge variant={badge.variant || "neutral"} className="ml-0.5">
+              {badge.text}
+            </Badge>
+          </Tooltip>
+        ))}
       </H2>
       <div className="my-1">
         <MDXContentClient content={operation.description} />

www/apps/api-reference/generated/generated-admin-sidebar.mjs

@@ -270,6 +270,24 @@ const generatedgeneratedAdminSidebarSidebar = {
       "loaded": false,
       "showLoadingIfEmpty": true
     },
+    {
+      "type": "category",
+      "title": "Gift Cards",
+      "children": [
+        {
+          "type": "link",
+          "path": "gift-cards_giftcard_schema",
+          "title": "GiftCard Object",
+          "loaded": true,
+          "badge": {
+            "variant": "neutral",
+            "text": "Schema"
+          }
+        }
+      ],
+      "loaded": false,
+      "showLoadingIfEmpty": true
+    },
     {
       "type": "category",
       "title": "Inventory Items",
@@ -709,6 +727,24 @@ const generatedgeneratedAdminSidebarSidebar = {
       "loaded": false,
       "showLoadingIfEmpty": true
     },
+    {
+      "type": "category",
+      "title": "Store Credit Accounts",
+      "children": [
+        {
+          "type": "link",
+          "path": "store-credit-accounts_storecreditaccount_schema",
+          "title": "StoreCreditAccount Object",
+          "loaded": true,
+          "badge": {
+            "variant": "neutral",
+            "text": "Schema"
+          }
+        }
+      ],
+      "loaded": false,
+      "showLoadingIfEmpty": true
+    },
     {
       "type": "category",
       "title": "Stores",
@@ -781,6 +817,24 @@ const generatedgeneratedAdminSidebarSidebar = {
       "loaded": false,
       "showLoadingIfEmpty": true
     },
+    {
+      "type": "category",
+      "title": "Transaction Groups",
+      "children": [
+        {
+          "type": "link",
+          "path": "transaction-groups_transactiongroup_schema",
+          "title": "TransactionGroup Object",
+          "loaded": true,
+          "badge": {
+            "variant": "neutral",
+            "text": "Schema"
+          }
+        }
+      ],
+      "loaded": false,
+      "showLoadingIfEmpty": true
+    },
     {
       "type": "category",
       "title": "Uploads",

www/apps/api-reference/generated/generated-store-sidebar.mjs

@@ -132,6 +132,42 @@ const generatedgeneratedStoreSidebarSidebar = {
       "loaded": false,
       "showLoadingIfEmpty": true
     },
+    {
+      "type": "category",
+      "title": "Gift Card Invitations",
+      "children": [
+        {
+          "type": "link",
+          "path": "gift-card-invitations_giftcardinvitation_schema",
+          "title": "GiftCardInvitation Object",
+          "loaded": true,
+          "badge": {
+            "variant": "neutral",
+            "text": "Schema"
+          }
+        }
+      ],
+      "loaded": false,
+      "showLoadingIfEmpty": true
+    },
+    {
+      "type": "category",
+      "title": "Gift Cards",
+      "children": [
+        {
+          "type": "link",
+          "path": "gift-cards_giftcard_schema",
+          "title": "GiftCard Object",
+          "loaded": true,
+          "badge": {
+            "variant": "neutral",
+            "text": "Schema"
+          }
+        }
+      ],
+      "loaded": false,
+      "showLoadingIfEmpty": true
+    },
     {
       "type": "category",
       "title": "Orders",
@@ -278,12 +314,12 @@ const generatedgeneratedStoreSidebarSidebar = {
     },
     {
       "type": "category",
-      "title": "Returns",
+      "title": "Return Reasons",
       "children": [
         {
           "type": "link",
-          "path": "returns_return_schema",
-          "title": "Return Object",
+          "path": "return-reasons_returnreason_schema",
+          "title": "ReturnReason Object",
           "loaded": true,
           "badge": {
             "variant": "neutral",
@@ -296,12 +332,12 @@ const generatedgeneratedStoreSidebarSidebar = {
     },
     {
       "type": "category",
-      "title": "Return Reasons",
+      "title": "Returns",
       "children": [
         {
           "type": "link",
-          "path": "return-reasons_returnreason_schema",
-          "title": "ReturnReason Object",
+          "path": "returns_return_schema",
+          "title": "Return Object",
           "loaded": true,
           "badge": {
             "variant": "neutral",
@@ -329,6 +365,24 @@ const generatedgeneratedStoreSidebarSidebar = {
       ],
       "loaded": false,
       "showLoadingIfEmpty": true
+    },
+    {
+      "type": "category",
+      "title": "Store Credit Accounts",
+      "children": [
+        {
+          "type": "link",
+          "path": "store-credit-accounts_storecreditaccount_schema",
+          "title": "StoreCreditAccount Object",
+          "loaded": true,
+          "badge": {
+            "variant": "neutral",
+            "text": "Schema"
+          }
+        }
+      ],
+      "loaded": false,
+      "showLoadingIfEmpty": true
     }
   ],
   "custom_autogenerate": "api-ref"

www/apps/api-reference/specs/admin/code_samples/Shell/admin_gift-cards/get.sh

@@ -0,0 +1,2 @@
+curl '{backend_url}/admin/gift-cards' \
+-H 'Authorization: Bearer {access_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_gift-cards/post.sh

@@ -0,0 +1,14 @@
+curl -X POST '{backend_url}/admin/gift-cards' \
+-H 'Authorization: Bearer {access_token}' \
+-H 'Content-Type: application/json' \
+--data-raw '{
+  "code": "{value}",
+  "value": 19,
+  "currency_code": "bwp",
+  "expires_at": "2025-07-20T15:47:23.951Z",
+  "reference_id": "{value}",
+  "reference": "{value}",
+  "line_item_id": "{value}",
+  "customer_id": "{value}",
+  "metadata": {}
+}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_gift-cards_{id}/get.sh

@@ -0,0 +1,2 @@
+curl '{backend_url}/admin/gift-cards/{id}' \
+-H 'Authorization: Bearer {access_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_gift-cards_{id}/post.sh

@@ -0,0 +1,2 @@
+curl -X POST '{backend_url}/admin/gift-cards/{id}' \
+-H 'Authorization: Bearer {access_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_gift-cards_{id}_redeem/post.sh

@@ -0,0 +1,6 @@
+curl -X POST '{backend_url}/admin/gift-cards/{id}/redeem' \
+-H 'Authorization: Bearer {access_token}' \
+-H 'Content-Type: application/json' \
+--data-raw '{
+  "customer_id": "{value}"
+}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_gift-cards_{id}_transfer/post.sh

@@ -0,0 +1,6 @@
+curl -X POST '{backend_url}/admin/gift-cards/{id}/transfer' \
+-H 'Authorization: Bearer {access_token}' \
+-H 'Content-Type: application/json' \
+--data-raw '{
+  "customer_id": "{value}"
+}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_store-credit-accounts/get.sh

@@ -0,0 +1,2 @@
+curl '{backend_url}/admin/store-credit-accounts' \
+-H 'Authorization: Bearer {access_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_store-credit-accounts/post.sh

@@ -0,0 +1,7 @@
+curl -X POST '{backend_url}/admin/store-credit-accounts' \
+-H 'Authorization: Bearer {access_token}' \
+-H 'Content-Type: application/json' \
+--data-raw '{
+  "currency_code": "nzd",
+  "customer_id": "{value}"
+}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_store-credit-accounts_{id}/get.sh

@@ -0,0 +1,2 @@
+curl '{backend_url}/admin/store-credit-accounts/{id}' \
+-H 'Authorization: Bearer {access_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_store-credit-accounts_{id}_transactions/get.sh

@@ -0,0 +1,2 @@
+curl '{backend_url}/admin/store-credit-accounts/{id}/transactions' \
+-H 'Authorization: Bearer {access_token}'

www/apps/api-reference/specs/admin/code_samples/Shell/admin_transaction-groups/get.sh

@@ -0,0 +1,2 @@
+curl '{backend_url}/admin/transaction-groups' \
+-H 'Authorization: Bearer {access_token}'

www/apps/api-reference/specs/admin/components/schemas/AdminCreateGiftCardParams.yaml

@@ -0,0 +1,51 @@
+type: object
+description: The details of the gift card to create.
+x-schemaName: AdminCreateGiftCardParams
+required:
+  - code
+  - value
+  - currency_code
+  - expires_at
+  - reference_id
+  - reference
+  - line_item_id
+  - customer_id
+  - metadata
+properties:
+  code:
+    type: string
+    title: code
+    description: The gift card's code.
+  value:
+    type: number
+    title: value
+    description: The gift card's amount.
+    example: 20
+  currency_code:
+    type: string
+    title: currency_code
+    description: The gift card's currency code.
+    example: usd
+  expires_at:
+    type: string
+    title: expires_at
+    description: The date the gift card expires at.
+  reference_id:
+    type: string
+    title: reference_id
+    description: The gift card's reference ID.
+  reference:
+    type: string
+    title: reference
+    description: The gift card's reference.
+  line_item_id:
+    type: string
+    title: line_item_id
+    description: The ID of the line item associated with the gift card.
+  customer_id:
+    type: string
+    title: customer_id
+    description: The ID of the customer associated with the gift card.
+  metadata:
+    type: object
+    description: The gift card's metadata, can hold custom key-value pairs.

www/apps/api-reference/specs/admin/components/schemas/AdminCreateStoreCreditAccount.yaml

@@ -0,0 +1,19 @@
+type: object
+description: The details of the store credit account to create.
+x-schemaName: AdminCreateStoreCreditAccount
+required:
+  - currency_code
+  - customer_id
+properties:
+  currency_code:
+    type: string
+    title: currency_code
+    description: The store credit account's currency code.
+    example: usd
+  customer_id:
+    type: string
+    title: customer_id
+    description: The ID of the customer that the store credit account belongs to.
+  metadata:
+    type: object
+    description: The store credit account's metadata, can hold custom key-value pairs.