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

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/apps/api-reference/specs/admin/components/schemas/AdminClaimListResponse.yaml

@@ -24,3 +24,10 @@ properties:
     description: The list of claims.
     items:
       $ref: ./AdminClaim.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of product collections.
     items:
       $ref: ./AdminCollection.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -1,17 +0,0 @@
-type: object
-description: the product collection's details.
-x-schemaName: AdminCreateCollection
-required:
-  - title
-properties:
-  title:
-    type: string
-    title: title
-    description: The collection's title.
-  handle:
-    type: string
-    title: handle
-    description: The collection's handle.
-  metadata:
-    type: object
-    description: The collection's metadata, used to store custom key-value pairs.

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

@@ -54,3 +54,9 @@ properties:
   metadata:
     type: object
     description: The tax region's metadata, used to store custom key-value pairs.
+  provider_id:
+    type: string
+    title: provider_id
+    description: >-
+      The ID of the tax provider used to calculate the tax rate in this tax
+      region.

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

@@ -24,3 +24,10 @@ properties:
     description: The list of currencies.
     items:
       $ref: ./AdminCurrency.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of draft orders.
     items:
       $ref: ./AdminDraftOrder.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of fulfillment providers.
     items:
       $ref: ./AdminFulfillmentProvider.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of fulfillment options.
     items:
       $ref: ./AdminFulfillmentProviderOption.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of notifications.
     items:
       $ref: ./AdminNotification.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of price lists.
     items:
       $ref: ./AdminPriceList.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of price preferences.
     items:
       $ref: ./AdminPricePreference.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of product categories.
     items:
       $ref: ./AdminProductCategory.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of product tags.
     items:
       $ref: ./AdminProductTag.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of product types.
     items:
       $ref: ./AdminProductType.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of return reasons.
     items:
       $ref: ./AdminReturnReason.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of stock locations.
     items:
       $ref: ./AdminStockLocation.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of stores.
     items:
       $ref: ./AdminStore.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -0,0 +1,16 @@
+type: object
+description: The tax provider's details.
+x-schemaName: AdminTaxProvider
+required:
+  - id
+  - is_enabled
+properties:
+  id:
+    type: string
+    title: id
+    description: The tax provider's ID.
+    example: tp_taxjar_taxjar
+  is_enabled:
+    type: boolean
+    title: is_enabled
+    description: Whether the tax provider is enabled in the Medusa application.

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

@@ -1,15 +0,0 @@
-type: object
-description: The details to update in a collection.
-x-schemaName: AdminUpdateCollection
-properties:
-  title:
-    type: string
-    title: title
-    description: The collection's title.
-  handle:
-    type: string
-    title: handle
-    description: The collection's handle.
-  metadata:
-    type: object
-    description: The collection's metadata, can hold custom key-value pairs.

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

@@ -13,3 +13,9 @@ properties:
   metadata:
     type: object
     description: The tax region's metadata, can hold custom key-value pairs.
+  provider_id:
+    type: string
+    title: provider_id
+    description: >-
+      The ID of the tax provider to use when calculating taxes for this tax
+      region.

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

@@ -24,3 +24,10 @@ properties:
     description: The list of users.
     items:
       $ref: ./AdminUser.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -52,7 +52,7 @@ properties:
     type: string
     title: province
     description: The address's lower-case ISO 3166-2 province code.
-    example: US-CA
+    example: us-ca
     externalDocs:
       url: https://en.wikipedia.org/wiki/ISO_3166-2
       description: Learn more about ISO 3166-2

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

@@ -24,3 +24,10 @@ properties:
     description: The list of currencies.
     items:
       $ref: ./StoreCurrency.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of addresses.
     items:
       $ref: ./StoreCustomerAddress.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of product categories.
     items:
       $ref: ./StoreProductCategory.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of product tags.
     items:
       $ref: ./StoreProductTag.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -24,3 +24,10 @@ properties:
     description: The list of product types.
     items:
       $ref: ./StoreProductType.yaml
+  estimate_count:
+    type: number
+    title: estimate_count
+    description: >-
+      The estimated count retrieved from the PostgreSQL query planner, which may
+      be inaccurate.
+    x-featureFlag: index_engine

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

@@ -10,53 +10,58 @@ required:
   - canceled_at
   - received_at
 properties:
-  id:
-    type: string
-    title: id
-    description: The return's ID.
-  order_id:
-    type: string
-    title: order_id
-    description: The ID of the order this return is created for.
-  status:
-    type: string
-    title: status
-    description: The return's status.
-  exchange_id:
-    type: string
-    title: exchange_id
-    description: The ID of the associated exchange.
-  location_id:
-    type: string
-    title: location_id
-    description: The ID of the location the items are returned to.
-  claim_id:
-    type: string
-    title: claim_id
-    description: The ID of the associated claim.
-  display_id:
-    type: number
-    title: display_id
-    description: The return's display ID.
-  refund_amount:
-    type: number
-    title: refund_amount
-    description: The return's refunded amount.
   items:
     type: array
     description: The return's items.
     items:
       $ref: ./StoreReturnItem.yaml
-  received_at:
+  status:
     type: string
-    title: received_at
-    description: The date the return was received.
+    description: The return's status.
+    enum:
+      - received
+      - canceled
+      - requested
+      - open
+      - partially_received
+  id:
+    type: string
+    title: id
+    description: The return's ID.
+  display_id:
+    type: number
+    title: display_id
+    description: The return's display ID.
   created_at:
     type: string
     format: date-time
     title: created_at
     description: The date the return was created.
+  order_id:
+    type: string
+    title: order_id
+    description: The ID of the order this return belongs to.
+  location_id:
+    type: string
+    title: location_id
+    description: The ID of the location the return items are being returned to.
   canceled_at:
     type: string
     title: canceled_at
-    description: The date the return was updated.
+    description: The date the return was canceled.
+  exchange_id:
+    type: string
+    title: exchange_id
+    description: The ID of the associated exchange.
+  claim_id:
+    type: string
+    title: claim_id
+    description: The ID of the associated claim.
+  refund_amount:
+    type: number
+    title: refund_amount
+    description: The amount to be refunded.
+  received_at:
+    type: string
+    title: received_at
+    description: The date the return items were received.

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

@@ -1,6 +1,13 @@
 type: object
 description: The return item's details.
 x-schemaName: StoreReturnItem
+required:
+  - id
+  - quantity
+  - received_quantity
+  - damaged_quantity
+  - item_id
+  - return_id
 properties:
   id:
     type: string
@@ -37,10 +44,3 @@ properties:
   metadata:
     type: object
     description: The item's metadata, can hold custom key-value pairs.
-required:
-  - id
-  - quantity
-  - received_quantity
-  - damaged_quantity
-  - item_id
-  - return_id