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

docs: update OAS for loyalty plugin (#12836)

Browse Source 
* updates

* cleanup

* generate OAS

* update links
This commit is contained in:
Shahed Nasser
2025-06-26 17:22:18 +03:00
committed by GitHub
parent 2983c7c3a5
commit 7d95eb73d3
81 changed files with 463 additions and 2001 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/schemas/AdminGiftCard.ts
-3
View File
@@ -6,7 +6,6 @@
* required:
* - line_item
* - customer
* - invitation
* - id
* - code
* - status
@@ -67,8 +66,6 @@
* type: string
* title: expires_at
* description: The date the gift card expires at.
* invitation:
* $ref: "#/components/schemas/AdminGiftCardInvitation"
* created_at:
* type: string
* format: date-time
www/utils/generated/oas-output/schemas/AdminGiftCardInvitation.ts
-42
View File
@@ -1,42 +0,0 @@
/**
* @schema AdminGiftCardInvitation
* 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:
* $ref: "#/components/schemas/AdminGiftCard"
* x-schemaName: AdminGiftCardInvitation
*
*/
www/utils/generated/oas-output/schemas/AdminGiftCardsResponse.ts
+5
View File
@@ -26,6 +26,11 @@
* description: The list of gift cards.
* items:
* $ref: "#/components/schemas/AdminGiftCard"
* estimate_count:
* type: number
* title: estimate_count
* description: The gift card's estimate count.
* x-featureFlag: index_engine
*
*/
www/utils/generated/oas-output/schemas/AdminStoreCreditAccountsResponse.ts
+5
View File
@@ -26,6 +26,11 @@
* description: The list of store credit accounts.
* items:
* $ref: "#/components/schemas/AdminStoreCreditAccount"
* estimate_count:
* type: number
* title: estimate_count
* description: The store credit account's estimate count.
* x-featureFlag: index_engine
*
*/
www/utils/generated/oas-output/schemas/AdminTransactionGroupsResponse.ts
+5
View File
@@ -26,6 +26,11 @@
* description: The list of transaction groups.
* items:
* $ref: "#/components/schemas/AdminTransactionGroup"
* estimate_count:
* type: number
* title: estimate_count
* description: The transaction group's estimate count.
* x-featureFlag: index_engine
*
*/
www/utils/generated/oas-output/schemas/AdminTransactionsResponse.ts
+5
View File
@@ -26,6 +26,11 @@
* description: The list of transactions.
* items:
* $ref: "#/components/schemas/AdminTransaction"
* estimate_count:
* type: number
* title: estimate_count
* description: The store credit account's estimate count.
* x-featureFlag: index_engine
*
*/
www/utils/generated/oas-output/schemas/AdminTransferGiftCard.ts
-15
View File
@@ -1,15 +0,0 @@
/**
* @schema AdminTransferGiftCard
* 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/utils/generated/oas-output/schemas/StoreCreateGiftCardInvitation.ts
-21
View File
@@ -1,21 +0,0 @@
/**
* @schema StoreCreateGiftCardInvitation
* 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/utils/generated/oas-output/schemas/StoreGiftCard.ts
+21 -23
View File
@@ -6,7 +6,6 @@
* required:
* - customer
* - line_item
* - invitation
* - id
* - code
* - status
@@ -22,6 +21,12 @@
* properties:
* customer:
* $ref: "#/components/schemas/StoreCustomer"
* line_item:
* $ref: "#/components/schemas/StoreOrderLineItem"
* id:
* type: string
* title: id
* description: The gift card's ID.
* code:
* type: string
* title: code
@@ -36,22 +41,32 @@
* 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
@@ -62,23 +77,6 @@
* 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:
* $ref: "#/components/schemas/StoreGiftCardInvitation"
* line_item:
* $ref: "#/components/schemas/StoreOrderLineItem"
*
*
*/
www/utils/generated/oas-output/schemas/StoreGiftCardInvitationResponse.ts
-13
View File
@@ -1,13 +0,0 @@
/**
* @schema StoreGiftCardInvitationResponse
* type: object
* description: The gift card invitation's details.
* x-schemaName: StoreGiftCardInvitationResponse
* required:
* - gift_card_invitation
* properties:
* gift_card_invitation:
* $ref: "#/components/schemas/StoreGiftCardInvitation"
*
*/
www/utils/generated/oas-output/schemas/StoreStoreCreditAccountsResponse.ts
+5
View File
@@ -26,6 +26,11 @@
* description: The list of store credit accounts.
* items:
* $ref: "#/components/schemas/StoreStoreCreditAccount"
* estimate_count:
* type: number
* title: estimate_count
* description: The store credit account's estimate count.
* x-featureFlag: index_engine
*
*/