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

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>

www/utils/generated/oas-output/schemas/AdminApiKey.ts

@@ -12,8 +12,10 @@
  *   - last_used_at
  *   - created_by
  *   - created_at
+ *   - updated_at
  *   - revoked_by
  *   - revoked_at
+ *   - deleted_at
  * properties:
  *   id:
  *     type: string
@@ -61,6 +63,16 @@
  *     title: revoked_at
  *     description: The date and time the API key was revoked. The API key is considered revoked when this property is set.
  *     format: date-time
+ *   updated_at:
+ *     type: string
+ *     format: date-time
+ *     title: updated_at
+ *     description: The date the API key was updated.
+ *   deleted_at:
+ *     type: string
+ *     format: date-time
+ *     title: deleted_at
+ *     description: The date the API key was deleted.
  * 
 */
 

www/utils/generated/oas-output/schemas/AdminCampaign.ts

@@ -12,6 +12,9 @@
  *   - starts_at
  *   - ends_at
  *   - budget
+ *   - created_at
+ *   - updated_at
+ *   - deleted_at
  * properties:
  *   id:
  *     type: string
@@ -77,6 +80,21 @@
  *         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.
+ *   created_at:
+ *     type: string
+ *     format: date-time
+ *     title: created_at
+ *     description: The date the campaign was created.
+ *   updated_at:
+ *     type: string
+ *     format: date-time
+ *     title: updated_at
+ *     description: The date the campaign was updated.
+ *   deleted_at:
+ *     type: string
+ *     format: date-time
+ *     title: deleted_at
+ *     description: The date the campaign was deleted.
  * 
 */
 

www/utils/generated/oas-output/schemas/AdminCollection.ts

@@ -43,7 +43,7 @@
  *     type: array
  *     description: The collection's products.
  *     items:
- *       $ref: "#/components/schemas/AdminProduct"
+ *       $ref: "#/components/schemas/BaseProduct"
  *   metadata:
  *     type: object
  *     description: The collection's metadata, used to store custom key-value pairs.

www/utils/generated/oas-output/schemas/AdminCreateProduct.ts

@@ -148,6 +148,10 @@
  *   metadata:
  *     type: object
  *     description: The product's metadata, used to store custom key-value pairs.
+ *   external_id:
+ *     type: string
+ *     title: external_id
+ *     description: The ID of the product in an external or third-party system.
  * 
 */
 

www/utils/generated/oas-output/schemas/AdminPromotion.ts

@@ -5,6 +5,9 @@
  * x-schemaName: AdminPromotion
  * required:
  *   - id
+ *   - created_at
+ *   - updated_at
+ *   - deleted_at
  * properties:
  *   application_method:
  *     $ref: "#/components/schemas/AdminApplicationMethod"
@@ -38,6 +41,21 @@
  *     description: The ID of the campaign this promotion belongs to.
  *   campaign:
  *     $ref: "#/components/schemas/AdminCampaign"
+ *   created_at:
+ *     type: string
+ *     format: date-time
+ *     title: created_at
+ *     description: The date the promotion was created.
+ *   updated_at:
+ *     type: string
+ *     format: date-time
+ *     title: updated_at
+ *     description: The date the promotion was updated.
+ *   deleted_at:
+ *     type: string
+ *     format: date-time
+ *     title: deleted_at
+ *     description: The date the promotion was deleted.
  * 
 */
 

www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts

@@ -147,6 +147,10 @@
  *   metadata:
  *     type: object
  *     description: The product's metadata, can hold custom key-value pairs.
+ *   external_id:
+ *     type: string
+ *     title: external_id
+ *     description: The ID of the product in an external or third-party system.
  * 
 */
 

www/utils/generated/oas-output/schemas/BaseProduct.ts

@@ -1,7 +1,7 @@
 /**
  * @schema BaseProduct
  * type: object
- * description: The parent's product.
+ * description: The product's details.
  * x-schemaName: BaseProduct
  * required:
  *   - id
@@ -54,7 +54,7 @@
  *   is_giftcard:
  *     type: boolean
  *     title: is_giftcard
- *     description: The product's is giftcard.
+ *     description: Whether the product is a gift card.
  *   status:
  *     type: string
  *     description: The product's status.
@@ -66,7 +66,7 @@
  *   thumbnail:
  *     type: string
  *     title: thumbnail
- *     description: The product's thumbnail.
+ *     description: The product's thumbnail URL.
  *   width:
  *     type: number
  *     title: width
@@ -104,18 +104,18 @@
  *   collection_id:
  *     type: string
  *     title: collection_id
- *     description: The product's collection id.
+ *     description: The ID of the collection the product belongs to.
  *   categories:
  *     type: array
  *     description: The product's categories.
  *     items:
  *       $ref: "#/components/schemas/BaseProductCategory"
  *   type:
- *     $ref: "#/components/schemas/BaseProduct"
+ *     $ref: "#/components/schemas/BaseProductType"
  *   type_id:
  *     type: string
  *     title: type_id
- *     description: The product's type id.
+ *     description: The ID of the type the product belongs to.
  *   tags:
  *     type: array
  *     description: The product's tags.
@@ -139,29 +139,29 @@
  *   discountable:
  *     type: boolean
  *     title: discountable
- *     description: The product's discountable.
+ *     description: Whether the product is discountable.
  *   external_id:
  *     type: string
  *     title: external_id
- *     description: The product's external id.
+ *     description: The ID of the product in an external or third-party system.
  *   created_at:
  *     type: string
  *     format: date-time
  *     title: created_at
- *     description: The product's created at.
+ *     description: The date the product was created.
  *   updated_at:
  *     type: string
  *     format: date-time
  *     title: updated_at
- *     description: The product's updated at.
+ *     description: The date the product was updated.
  *   deleted_at:
  *     type: string
  *     format: date-time
  *     title: deleted_at
- *     description: The product's deleted at.
+ *     description: The date the product was deleted.
  *   metadata:
  *     type: object
- *     description: The product's metadata.
+ *     description: The product's metadata, can hold custom key-value pairs.
  * 
 */
 

www/utils/generated/oas-output/schemas/BaseProductType.ts

@@ -0,0 +1,40 @@
+/**
+ * @schema BaseProductType
+ * type: object
+ * description: The product type's details.
+ * x-schemaName: BaseProductType
+ * required:
+ *   - id
+ *   - value
+ *   - created_at
+ *   - updated_at
+ * properties:
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The type's ID.
+ *   value:
+ *     type: string
+ *     title: value
+ *     description: The type's value.
+ *   created_at:
+ *     type: string
+ *     format: date-time
+ *     title: created_at
+ *     description: The date the type was created.
+ *   updated_at:
+ *     type: string
+ *     format: date-time
+ *     title: updated_at
+ *     description: The date the type was updated.
+ *   deleted_at:
+ *     type: string
+ *     format: date-time
+ *     title: deleted_at
+ *     description: The date the type was deleted.
+ *   metadata:
+ *     type: object
+ *     description: The type's metadata, can hold custom key-value pairs.
+ * 
+*/
+

www/utils/generated/oas-output/schemas/StoreCartShippingOption.ts

@@ -0,0 +1,96 @@
+/**
+ * @schema StoreCartShippingOption
+ * type: object
+ * description: The shipping option's details.
+ * x-schemaName: StoreCartShippingOption
+ * required:
+ *   - id
+ *   - name
+ *   - price_type
+ *   - service_zone_id
+ *   - shipping_profile_id
+ *   - provider_id
+ *   - data
+ *   - type
+ *   - provider
+ *   - amount
+ * properties:
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The shipping option's ID.
+ *   name:
+ *     type: string
+ *     title: name
+ *     description: The shipping option's name.
+ *   price_type:
+ *     type: string
+ *     description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated
+ *       fulfillment provider.
+ *     enum:
+ *       - flat
+ *       - calculated
+ *   service_zone_id:
+ *     type: string
+ *     title: service_zone_id
+ *     description: The ID of the service zone the shipping option belongs to.
+ *   provider_id:
+ *     type: string
+ *     title: provider_id
+ *     description: The ID of the fulfillment provider handling this option.
+ *   provider:
+ *     type: object
+ *     description: The fulfillment provider's details.
+ *     required:
+ *       - id
+ *       - is_enabled
+ *     properties:
+ *       id:
+ *         type: string
+ *         title: id
+ *         description: The provider's ID.
+ *       is_enabled:
+ *         type: boolean
+ *         title: is_enabled
+ *         description: Whether the provider is enabled.
+ *   type:
+ *     type: object
+ *     description: The shipping option type's details.
+ *     required:
+ *       - id
+ *       - label
+ *       - description
+ *       - code
+ *     properties:
+ *       id:
+ *         type: string
+ *         title: id
+ *         description: The type's ID.
+ *       label:
+ *         type: string
+ *         title: label
+ *         description: The type's label.
+ *       description:
+ *         type: string
+ *         title: description
+ *         description: The type's description.
+ *       code:
+ *         type: string
+ *         title: code
+ *         description: The type's code.
+ *   shipping_profile_id:
+ *     type: string
+ *     title: shipping_profile_id
+ *     description: The ID of the associated shipping profile.
+ *   amount:
+ *     type: number
+ *     title: amount
+ *     description: The shipping option's amount.
+ *   data:
+ *     type: object
+ *     description: The shipping option's data, useful for the provider handling fulfillment.
+ *     externalDocs:
+ *       url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
+ * 
+*/
+

www/utils/generated/oas-output/schemas/StoreInitializePaymentSession.ts

@@ -0,0 +1,25 @@
+/**
+ * @schema StoreInitializePaymentSession
+ * type: object
+ * description: The payment session's details.
+ * required:
+ *   - provider_id
+ * properties:
+ *   provider_id:
+ *     type: string
+ *     title: provider_id
+ *     description: The ID of the payment provider the customer chose.
+ *     example: pp_stripe_stripe
+ *   context:
+ *     type: object
+ *     description: The payment's context, such as the customer or address details. If the customer is logged-in, the customer `id` is set in the context under a `customer.id` property.
+ *   data:
+ *     type: object
+ *     description: Any data necessary for the payment provider to process the payment.
+ *     externalDocs:
+ *       url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property
+ *       description: Learn more about the payment session's data property
+ * x-schemaName: StoreInitializePaymentSession
+ * 
+*/
+

www/utils/generated/oas-output/schemas/StoreShippingOptionListResponse.ts

@@ -10,7 +10,7 @@
  *     type: array
  *     description: The shipping option's shipping options.
  *     items:
- *       $ref: "#/components/schemas/StoreShippingOption"
+ *       $ref: "#/components/schemas/StoreCartShippingOption"
  * 
 */