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

chore(docs): Updated API Reference (automated) (#13794)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2025-10-21 09:14:39 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent 1d63ed8ce9
commit 3d0f4086b4
67 changed files with 2475 additions and 525 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/schemas/AdminCampaign.ts
+7
View File
@@ -53,6 +53,7 @@
* - currency_code
* - limit
* - used
* - attribute
* properties:
* id:
* type: string
@@ -80,6 +81,12 @@
* description: >
* How much of the budget has been used. If the limit is `spend`, this property holds the total amount discounted so far. If the limit is `usage`, it holds the number of times the campaign's
* promotions have been used so far.
* attribute:
* type: string
* title: attribute
* description: The cart attribute to limit the budget by.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/promotion/campaign#attribute-based-budgets
* created_at:
* type: string
* format: date-time
www/utils/generated/oas-output/schemas/AdminCreateCalculatedShippingOption.ts
+57
View File
@@ -0,0 +1,57 @@
/**
* @schema AdminCreateCalculatedShippingOption
* type: object
* description: The calculated shipping option's details.
* x-schemaName: AdminCreateCalculatedShippingOption
* required:
* - price_type
* - name
* - service_zone_id
* - shipping_profile_id
* - provider_id
* properties:
* price_type:
* type: string
* title: price_type
* description: The calculated shipping option's price type.
* enum:
* - calculated
* - flat
* name:
* type: string
* title: name
* description: The calculated shipping option's name.
* service_zone_id:
* type: string
* title: service_zone_id
* description: The ID of the associated service zone.
* shipping_profile_id:
* type: string
* title: shipping_profile_id
* description: The ID of the associated shipping profile.
* data:
* type: object
* description: The calculated shipping option's data.
* externalDocs:
* url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property
* provider_id:
* type: string
* title: provider_id
* description: The ID of the fulfillment provider handling this calculated shipping option.
* type:
* $ref: "#/components/schemas/AdminCreateShippingOptionType"
* type_id:
* type: string
* title: type_id
* description: The ID of the shipping option type that this shipping option belongs to.
* rules:
* type: array
* description: The calculated shipping option's rules.
* items:
* $ref: "#/components/schemas/AdminCreateShippingOptionRule"
* metadata:
* type: object
* description: The shipping option's metadata, can hold custom key-value pairs.
*
*/
www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts → www/utils/generated/oas-output/schemas/AdminCreateFlatRateShippingOption.ts
+72 -11
View File
@@ -1,20 +1,20 @@
/**
* @schema AdminCreateShippingOption
* @schema AdminCreateFlatRateShippingOption
* type: object
* description: The shipping option's details.
* x-schemaName: AdminCreateShippingOption
* description: The flat rate shipping option's details.
* x-schemaName: AdminCreateFlatRateShippingOption
* required:
* - price_type
* - prices
* - name
* - service_zone_id
* - shipping_profile_id
* - price_type
* - provider_id
* - prices
* properties:
* name:
* type: string
* title: name
* description: The shipping option's name.
* description: The flat-rate shipping option's name.
* service_zone_id:
* type: string
* title: service_zone_id
@@ -25,7 +25,7 @@
* description: The ID of the associated shipping profile.
* data:
* type: object
* description: The shipping option's data, useful for the fulfillment provider handling its processing.
* description: The flat-rate shipping option's data, useful for the fulfillment provider handling its processing.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
* price_type:
@@ -61,6 +61,35 @@
* type: number
* title: amount
* description: The price's amount.
* rules:
* type: array
* description: The price's rules.
* items:
* type: object
* description: The rule's details.
* x-schemaName: PriceRule
* required:
* - attribute
* - operator
* - value
* properties:
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* operator:
* type: string
* description: The rule's operator.
* enum:
* - gt
* - lt
* - eq
* - lte
* - gte
* value:
* type: number
* title: value
* description: The rule's value.
* - type: object
* description: The price's details.
* x-schemaName: AdminCreateShippingOptionPriceWithRegion
@@ -76,15 +105,47 @@
* type: number
* title: amount
* description: The price's amount.
* rules:
* type: array
* description: The price's rules.
* items:
* type: object
* description: The rule's details.
* x-schemaName: PriceRule
* required:
* - attribute
* - operator
* - value
* properties:
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* operator:
* type: string
* description: The rule's operator.
* enum:
* - gt
* - lt
* - eq
* - lte
* - gte
* value:
* type: number
* title: value
* description: The rule's value.
* type_id:
* type: string
* title: type_id
* description: The ID of the shipping option type that this shipping option belongs to.
* rules:
* type: array
* description: The shipping option's rules.
* items:
* $ref: "#/components/schemas/AdminCreateShippingOptionRule"
* type_id:
* type: string
* title: type_id
* description: The ID of the shipping option type that this shipping option belongs to.
* metadata:
* type: object
* description: The shipping option's metadata.
*
*/
www/utils/generated/oas-output/schemas/AdminCreateRefundReason.ts
+8
View File
@@ -5,6 +5,7 @@
* x-schemaName: AdminCreateRefundReason
* required:
* - label
* - code
* properties:
* label:
* type: string
@@ -14,6 +15,13 @@
* type: string
* title: description
* description: The refund reason's description.
* code:
* type: string
* title: code
* description: The refund reason's code.
* metadata:
* type: object
* description: The refund reason's metadata. Can hold custom key-value pairs.
*
*/
www/utils/generated/oas-output/schemas/AdminRefund.ts
+1 -1
View File
@@ -37,7 +37,7 @@
* payment:
* $ref: "#/components/schemas/BasePayment"
* refund_reason:
* $ref: "#/components/schemas/RefundReason"
* $ref: "#/components/schemas/BaseRefundReason"
*
*/
www/utils/generated/oas-output/schemas/AdminRefundReason.ts
+5 -1
View File
@@ -6,7 +6,7 @@
* required:
* - id
* - label
* - metadata
* - code
* - created_at
* - updated_at
* properties:
@@ -38,6 +38,10 @@
* format: date-time
* title: updated_at
* description: The date the refund reason was updated.
* code:
* type: string
* title: code
* description: The refund reason's code.
*
*/
www/utils/generated/oas-output/schemas/AdminRefundReasonDeleteResponse.ts
+26
View File
@@ -0,0 +1,26 @@
/**
* @schema AdminRefundReasonDeleteResponse
* type: object
* description: The deletion's details.
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The refund reason's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* default: refund_reason
* deleted:
* type: boolean
* title: deleted
* description: Whether the refund reason was deleted.
* x-schemaName: AdminRefundReasonDeleteResponse
*
*/
www/utils/generated/oas-output/schemas/AdminUpdatePaymentRefundReason.ts
+4
View File
@@ -11,6 +11,10 @@
* type: string
* title: description
* description: The refund reason's description.
* code:
* type: string
* title: code
* description: The refund reason's code.
* x-schemaName: AdminUpdatePaymentRefundReason
*
*/
www/utils/generated/oas-output/schemas/BaseCartLineItem.ts
-11
View File
@@ -13,17 +13,6 @@
* - unit_price
* - cart
* - cart_id
* - original_total
* - original_subtotal
* - original_tax_total
* - item_total
* - item_subtotal
* - item_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* properties:
* id:
* type: string
www/utils/generated/oas-output/schemas/BaseCartShippingMethod.ts
-8
View File
@@ -11,14 +11,6 @@
* - is_tax_inclusive
* - created_at
* - updated_at
* - original_total
* - original_subtotal
* - original_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* properties:
* id:
* type: string
www/utils/generated/oas-output/schemas/BaseRefund.ts
+1 -1
View File
@@ -37,7 +37,7 @@
* payment:
* $ref: "#/components/schemas/BasePayment"
* refund_reason:
* $ref: "#/components/schemas/RefundReason"
* $ref: "#/components/schemas/BaseRefundReason"
*
*/
www/utils/generated/oas-output/schemas/RefundReason.ts → www/utils/generated/oas-output/schemas/BaseRefundReason.ts
+7 -3
View File
@@ -1,12 +1,12 @@
/**
* @schema RefundReason
* @schema BaseRefundReason
* type: object
* description: The refund reason's details.
* x-schemaName: RefundReason
* x-schemaName: BaseRefundReason
* required:
* - id
* - label
* - metadata
* - code
* - created_at
* - updated_at
* properties:
@@ -38,6 +38,10 @@
* format: date-time
* title: updated_at
* description: The date the refund reason was updated.
* code:
* type: string
* title: code
* description: The refund reason's code.
*
*/
www/utils/generated/oas-output/schemas/StoreShippingOptionListResponse.ts
+127 -3
View File
@@ -1,16 +1,140 @@
/**
* @schema StoreShippingOptionListResponse
* type: object
* description: The shipping option's details.
* description: The list of shipping options.
* x-schemaName: StoreShippingOptionListResponse
* required:
* - shipping_options
* properties:
* shipping_options:
* type: array
* description: The shipping option's shipping options.
* description: The list of shipping options.
* items:
* $ref: "#/components/schemas/StoreCartShippingOption"
* allOf:
* - $ref: "#/components/schemas/StoreCartShippingOption"
* - type: object
* description: The shipping option's details.
* required:
* - service_zone
* properties:
* service_zone:
* type: object
* description: The shipping option's service zone.
* required:
* - id
* - fulfillment_set_id
* - fulfillment_set
* properties:
* id:
* type: string
* title: id
* description: The service zone's ID.
* fulfillment_set_id:
* type: string
* title: fulfillment_set_id
* description: The ID of the service zone's fulfillment set.
* fulfillment_set:
* type: object
* description: The service zone's fulfillment set.
* required:
* - id
* - type
* - location
* properties:
* id:
* type: string
* title: id
* description: The fulfillment set's ID.
* type:
* type: string
* title: type
* description: The fulfillment set's type.
* location:
* type: object
* description: The fulfillment set's location details.
* required:
* - id
* - address
* properties:
* id:
* type: string
* title: id
* description: The location's ID.
* address:
* type: object
* description: The location's address.
* x-schemaName: StoreFulfillmentAddress
* required:
* - id
* - company
* - address_1
* - address_2
* - city
* - country_code
* - province
* - postal_code
* - phone
* - metadata
* - created_at
* - updated_at
* - deleted_at
* properties:
* id:
* type: string
* title: id
* description: The address's ID.
* company:
* type: string
* title: company
* description: The address's company.
* address_1:
* type: string
* title: address_1
* description: The first line of the address.
* address_2:
* type: string
* title: address_2
* description: The second line of the address.
* city:
* type: string
* title: city
* description: The address's city.
* country_code:
* type: string
* title: country_code
* description: The address's country code.
* example: "us"
* province:
* type: string
* title: province
* description: The address's province.
* postal_code:
* type: string
* title: postal_code
* description: The address's postal code.
* phone:
* type: string
* title: phone
* description: The address's phone.
* metadata:
* type: object
* description: The address's metadata. Can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the address was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the address was updated.
* deleted_at:
* type: string
* format: date-time
* title: deleted_at
* description: The date the address was deleted.
* description: The shipping option's details.
*
*/