@epilot/sdk 2.7.1 → 2.7.2

package/definitions/customer-portal.json

@@ -1867,6 +1867,13 @@
                               "example": "CAA_ERROR"
                             }
                           }
+                        },
+                        "identity_providers": {
+                          "type": "array",
+                          "description": "SSO identity providers configured for the portal. Includes raw\n`oidc_config.client_secret` values so the admin UI can round-trip\nthem. Customers are encouraged to reference secrets via env\ntemplates (`{{ env.VAR }}`) rather than embed raw values.\n",
+                          "items": {
+                            "$ref": "#/components/schemas/ProviderConfig"
+                          }
                         }
                       }
                     }
@@ -1994,6 +2001,13 @@
                               "example": "CAA_ERROR"
                             }
                           }
+                        },
+                        "identity_providers": {
+                          "type": "array",
+                          "description": "SSO identity providers configured for the portal. Includes raw\n`oidc_config.client_secret` values so the admin UI can round-trip\nthem. Customers are encouraged to reference secrets via env\ntemplates (`{{ env.VAR }}`) rather than embed raw values.\n",
+                          "items": {
+                            "$ref": "#/components/schemas/ProviderConfig"
+                          }
                         }
                       }
                     }
@@ -7668,7 +7682,7 @@
         ],
         "responses": {
           "200": {
-            "description": "Resolved public SSO provider configuration",
+            "description": "Resolved public SSO provider configuration. The handler strips `oidc_config.client_secret` from the response (kept server-side for the token exchange); the schema includes it for shape compatibility with the portal-config response.",
             "content": {
               "application/json": {
                 "schema": {
@@ -10708,6 +10722,13 @@
                 "description": "Default admin users for pending user notification to notify"
               }
             }
+          },
+          "identity_providers": {
+            "type": "array",
+            "description": "SSO identity providers for the portal. When sent on a portal save (PUT/POST),\nthe list is fully synced — incoming providers are upserted and any existing\nproviders not in the list are deleted. Omit the field to leave SSO\nconfiguration unchanged; send an empty array to remove all providers.\n\nEach provider is persisted verbatim — `oidc_config.client_secret` is stored\nas sent. Customers are encouraged to reference an org env secret via\n`{{ env.VAR }}` rather than embed raw values.\n",
+            "items": {
+              "$ref": "#/components/schemas/ProviderConfig"
+            }
           }
         }
       },
@@ -14859,6 +14880,11 @@
                 "type": "string",
                 "description": "Lower allowed limit of the meter reading",
                 "example": "{{CallResponse.data.lower_limit}}"
+              },
+              "errorMessagePath": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
               }
             }
           },
@@ -14938,6 +14964,11 @@
               "dataPath": {
                 "type": "string",
                 "description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
+              },
+              "errorMessagePath": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
               }
             }
           },
@@ -15016,6 +15047,11 @@
               "dataPath": {
                 "type": "string",
                 "description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
+              },
+              "errorMessagePath": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
               }
             }
           },
@@ -15095,6 +15131,16 @@
               "url"
             ]
           },
+          "resolved": {
+            "type": "object",
+            "properties": {
+              "errorMessagePath": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
+              }
+            }
+          },
           "use_static_ips": {
             "type": "boolean",
             "deprecated": true,
@@ -15170,6 +15216,11 @@
               "dataPath": {
                 "type": "string",
                 "description": "Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level."
+              },
+              "errorMessagePath": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
               }
             }
           },
@@ -15248,6 +15299,11 @@
               "dataPath": {
                 "type": "string",
                 "description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
+              },
+              "errorMessagePath": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
               }
             }
           },
@@ -15611,7 +15667,7 @@
             "$ref": "#/components/schemas/ProviderDisplayName"
           },
           "oidc_config": {
-            "$ref": "#/components/schemas/OIDCProviderPublicConfig"
+            "$ref": "#/components/schemas/OIDCProviderConfig"
           },
           "mobile_oidc_config": {
             "$ref": "#/components/schemas/MoblieOIDCConfig"
@@ -15761,7 +15817,7 @@
       },
       "OIDCProviderConfig": {
         "type": "object",
-        "description": "OIDC provider configuration. All string fields support env var interpolation\n(incl. secrets) via mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.\n",
+        "description": "OIDC provider configuration. Values are resolved at SSO invocation time\n(login / callback), so the fields below may reference org env vars via\nmustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.\n\nFields used to render the SSO buttons up-front (`ProviderConfig.slug`,\n`ProviderConfig.display_name`) are NOT interpolated and must be literal.\n",
         "properties": {
           "type": {
             "type": "string",
@@ -15819,63 +15875,9 @@
           "scope"
         ]
       },
-      "OIDCProviderPublicConfig": {
-        "type": "object",
-        "description": "Public OIDC provider configuration. Same as OIDCProviderConfig but never includes\nthe `client_secret` field — it is kept server-side and only used to exchange the\nauthorization code at the SSO callback. String fields are returned with env var\nplaceholders already resolved when fetched via `GET /v2/portal/public/sso/providers/{provider_slug}`.\n",
-        "properties": {
-          "type": {
-            "type": "string",
-            "enum": [
-              "authorization_code",
-              "implicit"
-            ],
-            "default": "implicit"
-          },
-          "oidc_issuer": {
-            "type": "string",
-            "description": "Issuing Authority URL",
-            "example": "https://login.microsoftonline.com/33d4f3e5-3df2-421e-b92e-a63cfa680a88/v2.0"
-          },
-          "redirect_uri": {
-            "type": "string",
-            "description": "Redirect URI for the OIDC flow",
-            "example": "https://customer-portal.com/login"
-          },
-          "client_id": {
-            "type": "string",
-            "example": "ab81daf8-8b1f-42d6-94ca-c51621054c75"
-          },
-          "has_client_secret": {
-            "type": "boolean",
-            "description": "Whether the client secret is present (the value itself is kept server-side)",
-            "example": true
-          },
-          "scope": {
-            "type": "string",
-            "description": "Space-separated list of OAuth 2.0 scopes to request from OpenID Connect",
-            "example": "openid email"
-          },
-          "metadata": {
-            "$ref": "#/components/schemas/OIDCProviderMetadata"
-          },
-          "prompt": {
-            "type": "string",
-            "enum": [
-              "login",
-              "select_account",
-              "consent"
-            ]
-          }
-        },
-        "required": [
-          "oidc_issuer",
-          "client_id",
-          "scope"
-        ]
-      },
       "MoblieOIDCConfig": {
         "type": "object",
-        "description": "Mobile OIDC configuration. All string fields support env var interpolation\n(incl. secrets) via mustache-like templates, e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.\n",
+        "description": "Mobile OIDC configuration. Values are resolved at SSO invocation time, so the\nfields below may reference org env vars via mustache-like templates, e.g.\n`{{ env.MOBILE_CLIENT_SECRET }}`.\n",
         "properties": {
           "client_id": {
             "type": "string",
@@ -15892,6 +15894,18 @@
       "OIDCProviderMetadata": {
         "type": "object",
         "properties": {
+          "response_modes_supported": {
+            "type": "array",
+            "description": "Response modes the provider accepts (e.g. `form_post` for Apple)",
+            "items": {
+              "type": "string",
+              "enum": [
+                "form_post",
+                "fragment",
+                "query"
+              ]
+            }
+          },
           "authorization_endpoint": {
             "type": "string",
             "description": "URL of the authorization endpoint",

package/definitions/design-runtime.json

@@ -1 +1 @@
-{"s":"https://design-builder-api.{environment}.epilot.io","o":[["getAllDesigns","get","/v1/designs"],["addDesign","post","/v1/designs",null,1],["getDesign","get","/v1/designs/{designId}",[["designId","p",true]]],["deleteDesign","delete","/v1/designs/{designId}",[["designId","p",true]]],["updateDesign","put","/v1/designs/{designId}",[["designId","p",true]],1],["getThemeFromDesign","get","/v1/designs/{designId}/parse",[["designId","p",true],["orgId","q"],["theme","q",true]]],["uploadFile","post","/v1/designs/files",null,1],["getFiles","get","/v1/designs/files",[["type","q"]]],["getLimit","get","/v1/designs/limit"],["getBrands","get","/v1/brands"],["getConsumerDesign","get","/v1/designs/consumer/{application}/{consumerId}",[["consumerId","p",true],["application","p",true]]],["addConsumer","put","/v1/designs/addConsumer/{application}/{designId}",[["designId","p",true],["application","p",true]],1],["removeConsumer","put","/v1/designs/removeConsumer/{application}/{designId}",[["designId","p",true],["application","p",true]],1]],"sv":{"environment":{"default":"sls","enum":["sls","dev.sls","staging.sls"]}},"v":"3.0.3"}
+{"s":"https://design-builder-api.sls.epilot.io","o":[["getAllDesigns","get","/v1/designs"],["addDesign","post","/v1/designs",null,1],["getDesign","get","/v1/designs/{designId}",[["designId","p",true]]],["deleteDesign","delete","/v1/designs/{designId}",[["designId","p",true]]],["updateDesign","put","/v1/designs/{designId}",[["designId","p",true]],1],["getThemeFromDesign","get","/v1/designs/{designId}/parse",[["designId","p",true],["orgId","q"],["theme","q",true]]],["uploadFile","post","/v1/designs/files",null,1],["getFiles","get","/v1/designs/files",[["type","q"]]],["getLimit","get","/v1/designs/limit"],["getBrands","get","/v1/brands"],["getConsumerDesign","get","/v1/designs/consumer/{application}/{consumerId}",[["consumerId","p",true],["application","p",true]]],["addConsumer","put","/v1/designs/addConsumer/{application}/{designId}",[["designId","p",true],["application","p",true]],1],["removeConsumer","put","/v1/designs/removeConsumer/{application}/{designId}",[["designId","p",true],["application","p",true]],1]],"v":"3.0.3"}

package/definitions/design.json

@@ -12,17 +12,7 @@
   ],
   "servers": [
     {
-      "url": "https://design-builder-api.{environment}.epilot.io",
-      "variables": {
-        "environment": {
-          "default": "sls",
-          "enum": [
-            "sls",
-            "dev.sls",
-            "staging.sls"
-          ]
-        }
-      }
+      "url": "https://design-builder-api.sls.epilot.io"
     }
   ],
   "security": [
@@ -354,7 +344,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object"
+                  "$ref": "#/components/schemas/ParseThemeFromDesignResp"
                 }
               }
             }
@@ -1674,6 +1664,10 @@
           },
           "url": {
             "type": "string"
+          },
+          "file_id": {
+            "type": "string",
+            "description": "ID of the source file entity in the epilot file-entity system. Set when the file was picked from the File Manager (rather than uploaded directly to the design-builder bucket). Consumers resolve the live `public_url` via this reference. The org id is derived from the journey's owning org at render time (same convention as journey image blocks), so blueprint cross-org installs work without any extra remapping."
           }
         },
         "required": [
@@ -1716,6 +1710,52 @@
             "$ref": "#/components/schemas/Application"
           }
         }
+      },
+      "ParseThemeFromDesignResp": {
+        "type": "object",
+        "properties": {
+          "theme": {
+            "$ref": "#/components/schemas/Theme"
+          },
+          "design": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "last_modified_at": {
+                "type": "string"
+              },
+              "style_name": {
+                "type": "string"
+              },
+              "style": {
+                "type": "object",
+                "properties": {
+                  "logo": {
+                    "$ref": "#/components/schemas/LogoData"
+                  },
+                  "palette": {
+                    "$ref": "#/components/schemas/PaletteData"
+                  },
+                  "typography": {
+                    "$ref": "#/components/schemas/TypographyData"
+                  }
+                }
+              },
+              "custom_theme": {
+                "type": "string"
+              },
+              "use_custom_theme": {
+                "type": "boolean"
+              },
+              "journey_design_tokens": {
+                "type": "object",
+                "description": "Design tokens for journey customization (renamed from design_tokens)"
+              }
+            }
+          }
+        }
       }
     }
   }

package/definitions/journey-runtime.json

@@ -1 +1 @@
-{"s":"https://journey-config.sls.epilot.io","o":[["getJourneysByOrgId","get","/v1/journey/organization/{id}",[["id","p",true],["hydrate","q"]]],["getJourney","get","/v1/journey/configuration/{id}",[["id","p",true],["source","q"],["orgId","q"]]],["removeJourney","delete","/v1/journey/configuration/{id}",[["id","p",true]]],["getJourneyProducts","get","/v1/journey/products/{id}",[["id","p",true],["source","q"],["postal_code","q"],["city","q"],["street","q"],["street_number","q"]]],["createJourney","post","/v1/journey/configuration",[["skipAutomation","q"]],1],["updateJourney","put","/v1/journey/configuration",null,1],["patchUpdateJourney","patch","/v1/journey/configuration",null,1],["searchJourneys","post","/v1/journey/configuration/search",null,1],["generateDocument","post","/v1/journey/document:generate",null,1],["createJourneyV2","post","/v2/journey/configuration",[["skipAutomation","q"]],1],["updateJourneyV2","put","/v2/journey/configuration",null,1],["patchUpdateJourneyV2","patch","/v2/journey/configuration",null,1],["getJourneyV2","get","/v2/journey/configuration/{id}",[["id","p",true]]],["removeJourneyV2","delete","/v2/journey/configuration/{id}",[["id","p",true]]],["getSettingsForJourney","get","/v1/journey/{id}/settings",[["id","p",true]]],["getButtonOptions","get","/v1/journey/button-options",[["fileId","q",true]]]],"v":"3.0.0"}
+{"s":"https://journey-config.sls.epilot.io","o":[["getJourneysByOrgId","get","/v1/journey/organization/{id}",[["id","p",true],["hydrate","q"]]],["getJourney","get","/v1/journey/configuration/{id}",[["id","p",true],["version","q"],["source","q"],["orgId","q"]]],["removeJourney","delete","/v1/journey/configuration/{id}",[["id","p",true]]],["getJourneyProducts","get","/v1/journey/products/{id}",[["id","p",true],["source","q"],["postal_code","q"],["city","q"],["street","q"],["street_number","q"]]],["createJourney","post","/v1/journey/configuration",[["skipAutomation","q"]],1],["updateJourney","put","/v1/journey/configuration",null,1],["patchUpdateJourney","patch","/v1/journey/configuration",null,1],["searchJourneys","post","/v1/journey/configuration/search",null,1],["generateDocument","post","/v1/journey/document:generate",null,1],["createJourneyV2","post","/v2/journey/configuration",[["skipAutomation","q"]],1],["updateJourneyV2","put","/v2/journey/configuration",null,1],["patchUpdateJourneyV2","patch","/v2/journey/configuration",null,1],["getJourneyV2","get","/v2/journey/configuration/{id}",[["id","p",true],["version","q"]]],["removeJourneyV2","delete","/v2/journey/configuration/{id}",[["id","p",true]]],["getSettingsForJourney","get","/v1/journey/{id}/settings",[["id","p",true]]],["getButtonOptions","get","/v1/journey/button-options",[["fileId","q",true]]]],"v":"3.0.0"}

package/definitions/journey.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Journey API",
     "description": "API to configure journeys",
-    "version": "1.4.1"
+    "version": "1.4.2"
   },
   "security": [
     {
@@ -114,6 +114,16 @@
               "example": "509cdffe-424f-457a-95c2-9708c304ce77"
             }
           },
+          {
+            "name": "version",
+            "in": "query",
+            "description": "DynamoDB version to fetch. `0` (default) is the live row; positive integers are historical snapshots created on each save. Note: this is distinct from the `revisions` counter on the row body.",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "default": 0
+            }
+          },
           {
             "name": "source",
             "in": "query",
@@ -708,6 +718,16 @@
               "format": "uuid",
               "example": "509cdffe-424f-457a-95c2-9708c304ce77"
             }
+          },
+          {
+            "name": "version",
+            "in": "query",
+            "description": "DynamoDB version to fetch. `0` (default) is the live row; positive integers are historical snapshots created on each save. Note: this is distinct from the `revisions` counter on the row body.",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "default": 0
+            }
           }
         ],
         "responses": {

package/definitions/notes-runtime.json

@@ -1 +1 @@
-{"s":"https://notes.sls.epilot.io","o":[["createNote","post","/v1/note",null,1],["getNote","get","/v1/note/{id}",[["id","p",true],["hydrate","q"]]],["patchNote","patch","/v1/note/{id}",[["id","p",true]],1],["updateNote","put","/v1/note/{id}",[["id","p",true]],1],["deleteNote","delete","/v1/note/{id}",[["id","p",true]]],["searchNotesByContext","post","/v1/notes:search",null,1],["getNotesByContext","get","/v1/notes/{entity_id}",[["entity_id","p",true],["contexts","q"],["from","q"],["size","q"]]],["pinNote","post","/v1/note/{id}/pin",[["id","p",true]]],["getNoteContexts","get","/v1/note/{id}/context",[["id","p",true]]],["addNoteReaction","post","/v1/note/{id}/reaction",[["id","p",true]],1],["removeNoteReaction","delete","/v1/note/{id}/reaction/{emoji_shortcode}",[["id","p",true],["emoji_shortcode","p",true]]],["toggleNoteReactions","post","/v1/note/{id}/reactions/toggle",[["id","p",true]],1]]}
+{"s":"https://notes.sls.epilot.io","o":[["createNote","post","/v1/note",null,1],["getNote","get","/v1/note/{id}",[["id","p",true],["hydrate","q"]]],["patchNote","patch","/v1/note/{id}",[["id","p",true]],1],["updateNote","put","/v1/note/{id}",[["id","p",true]],1],["deleteNote","delete","/v1/note/{id}",[["id","p",true]]],["searchNotesByContext","post","/v1/notes:search",null,1],["getNotesByContext","get","/v1/notes/{entity_id}",[["entity_id","p",true],["contexts","q"],["filter","q"],["from","q"],["size","q"]]],["pinNote","post","/v1/note/{id}/pin",[["id","p",true]]],["archiveNote","post","/v1/note/{id}/archive",[["id","p",true]]],["unarchiveNote","post","/v1/note/{id}/unarchive",[["id","p",true]]],["getNoteContexts","get","/v1/note/{id}/context",[["id","p",true]]],["addNoteReaction","post","/v1/note/{id}/reaction",[["id","p",true]],1],["removeNoteReaction","delete","/v1/note/{id}/reaction/{emoji_shortcode}",[["id","p",true],["emoji_shortcode","p",true]]],["toggleNoteReactions","post","/v1/note/{id}/reactions/toggle",[["id","p",true]],1]]}

package/definitions/notes.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.2",
   "info": {
-    "version": "2.4.0",
+    "version": "2.6.0",
     "title": "Notes API",
     "description": "Facade API Backend for Epilot Notes feature",
     "contact": {
@@ -23,6 +23,9 @@
     },
     {
       "name": "Reactions"
+    },
+    {
+      "name": "Archive"
     }
   ],
   "security": [
@@ -285,6 +288,14 @@
               }
             }
           },
+          {
+            "in": "query",
+            "name": "filter",
+            "description": "Archive-state filter. 'active' (default) returns non-archived notes only, 'archived' returns only archived notes, 'all' returns both.",
+            "schema": {
+              "$ref": "#/components/schemas/NotesListFilter"
+            }
+          },
           {
             "in": "query",
             "name": "from",
@@ -347,6 +358,74 @@
         }
       }
     },
+    "/v1/note/{id}/archive": {
+      "post": {
+        "operationId": "archiveNote",
+        "summary": "archiveNote",
+        "description": "Archives a root Note entry by setting its `_archived_at` timestamp to the current server time. The same timestamp is cascaded to every comment under the note so the entire thread is hidden from default listings. Returns 400 if the supplied id is a comment.",
+        "tags": [
+          "Archive"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "description": "The Entity ID of the Note entry to archive",
+            "schema": {
+              "type": "string",
+              "description": "The Entity ID of the Note entry to archive"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response with the archived Note entity",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NoteEntity"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/note/{id}/unarchive": {
+      "post": {
+        "operationId": "unarchiveNote",
+        "summary": "unarchiveNote",
+        "description": "Unarchives a root Note entry by clearing its `_archived_at` value. The clear cascades to every comment under the note so the entire thread returns to the active view. Returns 400 if the supplied id is a comment.",
+        "tags": [
+          "Archive"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "description": "The Entity ID of the Note entry to unarchive",
+            "schema": {
+              "type": "string",
+              "description": "The Entity ID of the Note entry to unarchive"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response with the unarchived Note entity",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NoteEntity"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/note/{id}/context": {
       "get": {
         "operationId": "getNoteContexts",
@@ -726,6 +805,12 @@
               }
             },
             "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
+          },
+          "_archived_at": {
+            "type": "string",
+            "nullable": true,
+            "description": "The timestamp of when this Note was archived. Absent or null means the Note is active.",
+            "format": "date-time"
           }
         },
         "description": "A note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place."
@@ -927,6 +1012,12 @@
               }
             },
             "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
+          },
+          "_archived_at": {
+            "type": "string",
+            "nullable": true,
+            "description": "The timestamp of when this Note was archived. Absent or null means the Note is active.",
+            "format": "date-time"
           }
         }
       },
@@ -1051,6 +1142,12 @@
               }
             },
             "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
+          },
+          "_archived_at": {
+            "type": "string",
+            "nullable": true,
+            "description": "The timestamp of when this Note was archived. Absent or null means the Note is active.",
+            "format": "date-time"
           }
         }
       },
@@ -1194,6 +1291,12 @@
               }
             },
             "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
+          },
+          "_archived_at": {
+            "type": "string",
+            "nullable": true,
+            "description": "The timestamp of when this Note was archived. Absent or null means the Note is active.",
+            "format": "date-time"
           }
         },
         "required": [
@@ -1422,6 +1525,12 @@
               }
             },
             "description": "Reactions to the note, keyed by reaction type, with an array of user IDs for each type"
+          },
+          "_archived_at": {
+            "type": "string",
+            "nullable": true,
+            "description": "The timestamp of when this Note was archived. Absent or null means the Note is active.",
+            "format": "date-time"
           }
         }
       },
@@ -1454,6 +1563,9 @@
             },
             "description": "When set, the API resolves related entities of these schemas for the primary entity context and includes their notes in the results."
           },
+          "filter": {
+            "$ref": "#/components/schemas/NotesListFilter"
+          },
           "from": {
             "type": "number",
             "default": 0,
@@ -1469,6 +1581,16 @@
           "contexts"
         ]
       },
+      "NotesListFilter": {
+        "type": "string",
+        "enum": [
+          "all",
+          "active",
+          "archived"
+        ],
+        "default": "active",
+        "description": "Archive-state filter. 'active' (default) returns non-archived notes only, 'archived' returns only archived notes, 'all' returns both."
+      },
       "NotesSearchRequestResponse": {
         "type": "object",
         "properties": {