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

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

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>

Author: github-actions[bot]

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

@@ -14,6 +14,8 @@ required:
   - shipping_option_id
   - metadata
   - created_at
+  - created_by
+  - marked_shipped_by
   - updated_at
 properties:
   id:
@@ -80,3 +82,11 @@ properties:
     type: boolean
     title: requires_shipping
     description: Whether the fulfillment requires shipping.
+  created_by:
+    type: string
+    title: created_by
+    description: The ID of the user that created the fulfillment.
+  marked_shipped_by:
+    type: string
+    title: marked_shipped_by
+    description: The ID of the user that marked the fulfillment as shipped.

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

@@ -9,6 +9,7 @@ required:
   - display_id
   - received_at
   - created_at
+  - created_by
   - canceled_at
 properties:
   id:
@@ -76,3 +77,7 @@ properties:
     type: string
     title: received_at
     description: The date the return was received.
+  created_by:
+    type: string
+    title: created_by
+    description: The ID of the user that created the return.

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

@@ -14,6 +14,8 @@ required:
   - shipping_option_id
   - metadata
   - created_at
+  - created_by
+  - marked_shipped_by
   - updated_at
 properties:
   id:
@@ -80,3 +82,11 @@ properties:
     type: boolean
     title: requires_shipping
     description: Whether the fulfillment requires shipping.
+  created_by:
+    type: string
+    title: created_by
+    description: The ID of the user that created the fulfillment.
+  marked_shipped_by:
+    type: string
+    title: marked_shipped_by
+    description: The ID of the user that marked the fulfillment as shipped.

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

@@ -14,6 +14,8 @@ required:
   - shipping_option_id
   - metadata
   - created_at
+  - created_by
+  - marked_shipped_by
   - updated_at
 properties:
   id:
@@ -80,3 +82,11 @@ properties:
     type: boolean
     title: requires_shipping
     description: The fulfillment's requires shipping.
+  created_by:
+    type: string
+    title: created_by
+    description: The ID of the user that created the fulfillment.
+  marked_shipped_by:
+    type: string
+    title: marked_shipped_by
+    description: The ID of the user that marked the fulfillment as shipped.

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

@@ -8,6 +8,7 @@ required:
   - created_at
   - order_id
   - canceled_at
+  - created_by
   - received_at
 properties:
   items:
@@ -65,3 +66,7 @@ properties:
     type: string
     title: received_at
     description: The date the return items were received.
+  created_by:
+    type: string
+    title: created_by
+    description: The ID of the user that created the return.

www/apps/api-reference/specs/admin/openapi.full.yaml

@@ -25500,6 +25500,14 @@ paths:
                 metadata:
                   type: object
                   description: The invite's metadata. Can be custom data in key-value pairs.
+                roles:
+                  type: array
+                  description: The invited user's roles.
+                  x-featureFlag: rbac
+                  items:
+                    type: string
+                    title: roles
+                    description: The invited user's role.
       x-codeSamples:
         - lang: JavaScript
           label: JS SDK
@@ -66362,6 +66370,132 @@ paths:
             type: boolean
             title: with_deleted
             description: Whether to include deleted records in the result.
+        - name: state
+          in: query
+          required: false
+          schema:
+            oneOf:
+              - type: string
+                title: state
+                description: Filter by a workflow execution's state.
+              - type: array
+                description: Filter by workflow execution states.
+                items:
+                  type: string
+                  title: state
+                  description: A workflow execution state.
+        - name: created_at
+          in: query
+          description: Filter by the workflow execution's creation date.
+          required: false
+          schema:
+            type: object
+            properties:
+              $and:
+                type: array
+                description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
+                items:
+                  type: object
+              $or:
+                type: array
+                description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
+                items:
+                  type: object
+              $eq:
+                oneOf:
+                  - type: string
+                    title: $eq
+                    description: Filter by exact value.
+                  - type: array
+                    title: $eq
+                    description: Filter by exact value.
+                    items:
+                      type: string
+              $ne:
+                type: string
+                title: $ne
+                description: Filter by not equal to the given value.
+              $in:
+                type: array
+                title: $in
+                description: Filter by values included in the given array.
+                items:
+                  type: string
+              $nin:
+                type: array
+                title: $nin
+                description: Filter by values not included in the given array.
+                items:
+                  type: string
+              $not:
+                oneOf:
+                  - type: string
+                    title: $not
+                    description: Filter by not equal to the given value.
+                  - type: object
+                    title: $not
+                    description: Filter by values not matching the conditions in this parameter.
+                  - type: array
+                    title: $not
+                    description: Filter by values not matching the conditions in this parameter.
+                    items:
+                      type: string
+              $gt:
+                type: string
+                title: $gt
+                description: Filter by values greater than the given value.
+              $gte:
+                type: string
+                title: $gte
+                description: Filter by values greater than or equal to the given value.
+              $lt:
+                type: string
+                title: $lt
+                description: Filter by values less than the given value.
+              $lte:
+                type: string
+                title: $lte
+                description: Filter by values less than or equal to the given value.
+              $like:
+                type: string
+                title: $like
+                description: Apply a `like` filter. Useful for strings only.
+              $re:
+                type: string
+                title: $re
+                description: Apply a regex filter. Useful for strings only.
+              $ilike:
+                type: string
+                title: $ilike
+                description: Apply a case-insensitive `like` filter. Useful for strings only.
+              $fulltext:
+                type: string
+                title: $fulltext
+                description: Filter to apply on full-text properties.
+              $overlap:
+                type: array
+                title: $overlap
+                description: Filter to apply on array properties to find overlapping values.
+                items:
+                  type: string
+              $contains:
+                type: array
+                title: $contains
+                description: Filter to apply on array properties to find contained values.
+                items:
+                  type: string
+              $contained:
+                type: array
+                title: $contained
+                description: Filter to apply on array properties to find contained values.
+                items:
+                  type: string
+              $exists:
+                type: boolean
+                title: $exists
+                description: Filter by whether a value exists or not.
+            title: created_at
+            description: The workflows execution's created at.
       security:
         - api_token: []
         - cookie_auth: []
@@ -75509,6 +75643,8 @@ components:
         - shipping_option_id
         - metadata
         - created_at
+        - created_by
+        - marked_shipped_by
         - updated_at
       properties:
         id:
@@ -75572,6 +75708,14 @@ components:
           type: boolean
           title: requires_shipping
           description: Whether the fulfillment requires shipping.
+        created_by:
+          type: string
+          title: created_by
+          description: The ID of the user that created the fulfillment.
+        marked_shipped_by:
+          type: string
+          title: marked_shipped_by
+          description: The ID of the user that marked the fulfillment as shipped.
     AdminOrderItem:
       type: object
       description: The order item's details.
@@ -79324,6 +79468,7 @@ components:
         - display_id
         - received_at
         - created_at
+        - created_by
         - canceled_at
       properties:
         id:
@@ -79389,6 +79534,10 @@ components:
           type: string
           title: received_at
           description: The date the return was received.
+        created_by:
+          type: string
+          title: created_by
+          description: The ID of the user that created the return.
     AdminReturnItem:
       type: object
       description: The return item's details.
@@ -84967,6 +85116,8 @@ components:
         - shipping_option_id
         - metadata
         - created_at
+        - created_by
+        - marked_shipped_by
         - updated_at
       properties:
         id:
@@ -85030,6 +85181,14 @@ components:
           type: boolean
           title: requires_shipping
           description: Whether the fulfillment requires shipping.
+        created_by:
+          type: string
+          title: created_by
+          description: The ID of the user that created the fulfillment.
+        marked_shipped_by:
+          type: string
+          title: marked_shipped_by
+          description: The ID of the user that marked the fulfillment as shipped.
     BaseOrderItemDetail:
       type: object
       description: The item's detail.
@@ -91738,6 +91897,8 @@ components:
         - shipping_option_id
         - metadata
         - created_at
+        - created_by
+        - marked_shipped_by
         - updated_at
       properties:
         id:
@@ -91801,6 +91962,14 @@ components:
           type: boolean
           title: requires_shipping
           description: The fulfillment's requires shipping.
+        created_by:
+          type: string
+          title: created_by
+          description: The ID of the user that created the fulfillment.
+        marked_shipped_by:
+          type: string
+          title: marked_shipped_by
+          description: The ID of the user that marked the fulfillment as shipped.
     StoreOrderLineItem:
       type: object
       description: The item's details.
@@ -98734,6 +98903,7 @@ components:
         - created_at
         - order_id
         - canceled_at
+        - created_by
         - received_at
       properties:
         items:
@@ -98791,6 +98961,10 @@ components:
           type: string
           title: received_at
           description: The date the return items were received.
+        created_by:
+          type: string
+          title: created_by
+          description: The ID of the user that created the return.
     StoreReturnItem:
       type: object
       description: The return item's details.

www/apps/api-reference/specs/admin/paths/admin_invites.yaml

@@ -649,6 +649,14 @@ post:
             metadata:
               type: object
               description: The invite's metadata. Can be custom data in key-value pairs.
+            roles:
+              type: array
+              description: The invited user's roles.
+              x-featureFlag: rbac
+              items:
+                type: string
+                title: roles
+                description: The invited user's role.
   x-codeSamples:
     - lang: JavaScript
       label: JS SDK