docs: update OAS for loyalty plugin (#12836)

* updates

* cleanup

* generate OAS

* update links

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

@@ -4,7 +4,6 @@ x-schemaName: AdminGiftCard
 required:
   - line_item
   - customer
-  - invitation
   - id
   - code
   - status
@@ -65,8 +64,6 @@ properties:
     type: string
     title: expires_at
     description: The date the gift card expires at.
-  invitation:
-    $ref: ./AdminGiftCardInvitation.yaml
   created_at:
     type: string
     format: date-time

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

@@ -1,37 +0,0 @@
-type: object
-description: The gift card invitation details.
-required:
-  - gift_card
-  - id
-  - code
-  - status
-  - expires_at
-  - email
-properties:
-  id:
-    type: string
-    title: id
-    description: The invitation's ID.
-  email:
-    type: string
-    title: email
-    description: The invitation's email.
-    format: email
-  code:
-    type: string
-    title: code
-    description: The invitation's code.
-  status:
-    type: string
-    description: The invitation's status.
-    enum:
-      - pending
-      - accepted
-      - rejected
-  expires_at:
-    type: string
-    title: expires_at
-    description: The date the invitation expires at.
-  gift_card:
-    type: object
-x-schemaName: AdminGiftCardInvitation

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

@@ -24,3 +24,8 @@ properties:
     description: The list of gift cards.
     items:
       $ref: ./AdminGiftCard.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: The gift card's estimate count.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,8 @@ properties:
     description: The list of store credit accounts.
     items:
       $ref: ./AdminStoreCreditAccount.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: The store credit account's estimate count.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,8 @@ properties:
     description: The list of transaction groups.
     items:
       $ref: ./AdminTransactionGroup.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: The transaction group's estimate count.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,8 @@ properties:
     description: The list of transactions.
     items:
       $ref: ./AdminTransaction.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: The store credit account's estimate count.
+    x-featureFlag: index_engine

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

@@ -1,10 +0,0 @@
-type: object
-description: The details of the gift card transfer request.
-x-schemaName: AdminTransferGiftCard
-required:
-  - customer_id
-properties:
-  customer_id:
-    type: string
-    title: customer_id
-    description: The ID of the customer to transfer the gift card to.

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

@@ -1,16 +0,0 @@
-type: object
-description: The details to create a gift card invitation.
-x-schemaName: StoreCreateGiftCardInvitation
-required:
-  - email
-properties:
-  email:
-    type: string
-    title: email
-    description: The email address to send the gift card invitation to.
-    format: email
-  expires_at:
-    type: string
-    title: expires_at
-    description: The date the gift card invitation expires.
-    format: date-time

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

@@ -4,7 +4,6 @@ x-schemaName: StoreGiftCard
 required:
   - customer
   - line_item
-  - invitation
   - id
   - code
   - status
@@ -20,6 +19,12 @@ required:
 properties:
   customer:
     $ref: ./StoreCustomer.yaml
+  line_item:
+    $ref: ./StoreOrderLineItem.yaml
+  id:
+    type: string
+    title: id
+    description: The gift card's ID.
   code:
     type: string
     title: code
@@ -34,22 +39,32 @@ properties:
     type: number
     title: value
     description: The gift card's amount.
+  currency_code:
+    type: string
+    title: currency_code
+    description: The gift card's currency code.
+    example: usd
   customer_id:
     type: string
     title: customer_id
     description: The ID of the customer that the gift card belongs to.
-  id:
-    type: string
-    title: id
-    description: The gift card's ID.
   reference_id:
     type: string
     title: reference_id
     description: The gift card's reference ID.
+  note:
+    type: string
+    title: note
+    description: A note with more information about the gift card.
   reference:
     type: string
     title: reference
     description: The gift card's reference.
+  expires_at:
+    type: string
+    title: expires_at
+    description: The date the gift card expires.
+    format: date-time
   created_at:
     type: string
     format: date-time
@@ -60,20 +75,3 @@ properties:
     format: date-time
     title: updated_at
     description: The date the gift card was updated.
-  currency_code:
-    type: string
-    title: currency_code
-    description: The gift card's currency code.
-    example: usd
-  note:
-    type: string
-    title: note
-    description: The gift card's note.
-  expires_at:
-    type: string
-    title: expires_at
-    description: The date the gift card expires.
-  invitation:
-    type: object
-  line_item:
-    $ref: ./StoreOrderLineItem.yaml

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

@@ -1,8 +0,0 @@
-type: object
-description: The gift card invitation's details.
-x-schemaName: StoreGiftCardInvitationResponse
-required:
-  - gift_card_invitation
-properties:
-  gift_card_invitation:
-    $ref: ./StoreGiftCardInvitation.yaml

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

@@ -24,3 +24,8 @@ properties:
     description: The list of store credit accounts.
     items:
       $ref: ./StoreStoreCreditAccount.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: The store credit account's estimate count.
+    x-featureFlag: index_engine