@soat/sdk 0.95.0 → 0.96.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.cjs CHANGED
@@ -1100,7 +1100,7 @@ var ApiKeys = class {
1100
1100
  /**
1101
1101
  * Create an API key
1102
1102
  *
1103
- * Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped credential**, the new key is confined to that same project: omitting `project_id` defaults to it, naming a different project returns `403 API_KEY_PROJECT_SCOPE`, and `project_id: null` (an unscoped key) is likewise refused. Minting an unscoped key requires an unscoped credential.
1103
+ * Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped credential**, the new key is confined to that same project: omitting `project_id` defaults to it, naming a different project returns `403 API_KEY_PROJECT_SCOPE`, and `project_id: null` (an unscoped key) is likewise refused. Minting an unscoped key requires an unscoped credential. - When the request is authenticated with an **API key narrowed by `policy_ids`**, the new key stays inside that boundary: omitting `policy_ids` inherits the caller's own, a non-empty subset of them is accepted, and an empty list or any other policy returns `403 API_KEY_POLICY_BOUNDARY`.
1104
1104
  *
1105
1105
  */
1106
1106
  static createApiKey(options) {
@@ -1138,7 +1138,7 @@ var ApiKeys = class {
1138
1138
  /**
1139
1139
  * Update an API key
1140
1140
  *
1141
- * Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it.
1141
+ * Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it. An API key narrowed by `policy_ids` can only set `policy_ids` to a non-empty subset of its own (`403 API_KEY_POLICY_BOUNDARY` otherwise).
1142
1142
  */
1143
1143
  static updateApiKey(options) {
1144
1144
  return (options.client ?? client).put({
package/dist/index.d.cts CHANGED
@@ -11022,7 +11022,7 @@ type CreateApiKeyErrors = {
11022
11022
  */
11023
11023
  401: ErrorResponse;
11024
11024
  /**
11025
- * Forbidden (a project-scoped credential named a different project, or asked for an unscoped key)
11025
+ * Forbidden (a project-scoped credential named a different project, or asked for an unscoped key; or a key narrowed by `policy_ids` asked for a key outside its boundary)
11026
11026
  */
11027
11027
  403: ErrorResponse;
11028
11028
  /**
@@ -11167,7 +11167,7 @@ type UpdateApiKeyErrors = {
11167
11167
  */
11168
11168
  401: ErrorResponse;
11169
11169
  /**
11170
- * Forbidden (not the key owner or admin, or the credential is scoped to a different project)
11170
+ * Forbidden (not the key owner or admin, the credential is scoped to a different project, or a key narrowed by `policy_ids` asked for policies outside its boundary)
11171
11171
  */
11172
11172
  403: ErrorResponse;
11173
11173
  /**
@@ -12020,7 +12020,7 @@ type ListConversationsData = {
12020
12020
  */
12021
12021
  project_id?: string;
12022
12022
  /**
12023
- * Filter by actor ID
12023
+ * Only conversations owned by this actor (their `actor_id`); message authorship does not match.
12024
12024
  */
12025
12025
  actor_id?: string;
12026
12026
  /**
@@ -17829,7 +17829,7 @@ type ListIngestionRulesResponses = {
17829
17829
  };
17830
17830
  type ListIngestionRulesResponse = ListIngestionRulesResponses[keyof ListIngestionRulesResponses];
17831
17831
  type CreateIngestionRuleData = {
17832
- body: {
17832
+ body: unknown & {
17833
17833
  /**
17834
17834
  * Project ID (required if not using project key auth)
17835
17835
  */
@@ -28917,7 +28917,7 @@ export declare class ApiKeys {
28917
28917
  /**
28918
28918
  * Create an API key
28919
28919
  *
28920
- * Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped credential**, the new key is confined to that same project: omitting `project_id` defaults to it, naming a different project returns `403 API_KEY_PROJECT_SCOPE`, and `project_id: null` (an unscoped key) is likewise refused. Minting an unscoped key requires an unscoped credential.
28920
+ * Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped credential**, the new key is confined to that same project: omitting `project_id` defaults to it, naming a different project returns `403 API_KEY_PROJECT_SCOPE`, and `project_id: null` (an unscoped key) is likewise refused. Minting an unscoped key requires an unscoped credential. - When the request is authenticated with an **API key narrowed by `policy_ids`**, the new key stays inside that boundary: omitting `policy_ids` inherits the caller's own, a non-empty subset of them is accepted, and an empty list or any other policy returns `403 API_KEY_POLICY_BOUNDARY`.
28921
28921
  *
28922
28922
  */
28923
28923
  static createApiKey<ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>): RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
@@ -28936,7 +28936,7 @@ export declare class ApiKeys {
28936
28936
  /**
28937
28937
  * Update an API key
28938
28938
  *
28939
- * Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it.
28939
+ * Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it. An API key narrowed by `policy_ids` can only set `policy_ids` to a non-empty subset of its own (`403 API_KEY_POLICY_BOUNDARY` otherwise).
28940
28940
  */
28941
28941
  static updateApiKey<ThrowOnError extends boolean = false>(options: Options<UpdateApiKeyData, ThrowOnError>): RequestResult<UpdateApiKeyResponses, UpdateApiKeyErrors, ThrowOnError>;
28942
28942
  }
package/dist/index.d.mts CHANGED
@@ -11022,7 +11022,7 @@ type CreateApiKeyErrors = {
11022
11022
  */
11023
11023
  401: ErrorResponse;
11024
11024
  /**
11025
- * Forbidden (a project-scoped credential named a different project, or asked for an unscoped key)
11025
+ * Forbidden (a project-scoped credential named a different project, or asked for an unscoped key; or a key narrowed by `policy_ids` asked for a key outside its boundary)
11026
11026
  */
11027
11027
  403: ErrorResponse;
11028
11028
  /**
@@ -11167,7 +11167,7 @@ type UpdateApiKeyErrors = {
11167
11167
  */
11168
11168
  401: ErrorResponse;
11169
11169
  /**
11170
- * Forbidden (not the key owner or admin, or the credential is scoped to a different project)
11170
+ * Forbidden (not the key owner or admin, the credential is scoped to a different project, or a key narrowed by `policy_ids` asked for policies outside its boundary)
11171
11171
  */
11172
11172
  403: ErrorResponse;
11173
11173
  /**
@@ -12020,7 +12020,7 @@ type ListConversationsData = {
12020
12020
  */
12021
12021
  project_id?: string;
12022
12022
  /**
12023
- * Filter by actor ID
12023
+ * Only conversations owned by this actor (their `actor_id`); message authorship does not match.
12024
12024
  */
12025
12025
  actor_id?: string;
12026
12026
  /**
@@ -17829,7 +17829,7 @@ type ListIngestionRulesResponses = {
17829
17829
  };
17830
17830
  type ListIngestionRulesResponse = ListIngestionRulesResponses[keyof ListIngestionRulesResponses];
17831
17831
  type CreateIngestionRuleData = {
17832
- body: {
17832
+ body: unknown & {
17833
17833
  /**
17834
17834
  * Project ID (required if not using project key auth)
17835
17835
  */
@@ -28917,7 +28917,7 @@ export declare class ApiKeys {
28917
28917
  /**
28918
28918
  * Create an API key
28919
28919
  *
28920
- * Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped credential**, the new key is confined to that same project: omitting `project_id` defaults to it, naming a different project returns `403 API_KEY_PROJECT_SCOPE`, and `project_id: null` (an unscoped key) is likewise refused. Minting an unscoped key requires an unscoped credential.
28920
+ * Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped credential**, the new key is confined to that same project: omitting `project_id` defaults to it, naming a different project returns `403 API_KEY_PROJECT_SCOPE`, and `project_id: null` (an unscoped key) is likewise refused. Minting an unscoped key requires an unscoped credential. - When the request is authenticated with an **API key narrowed by `policy_ids`**, the new key stays inside that boundary: omitting `policy_ids` inherits the caller's own, a non-empty subset of them is accepted, and an empty list or any other policy returns `403 API_KEY_POLICY_BOUNDARY`.
28921
28921
  *
28922
28922
  */
28923
28923
  static createApiKey<ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>): RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
@@ -28936,7 +28936,7 @@ export declare class ApiKeys {
28936
28936
  /**
28937
28937
  * Update an API key
28938
28938
  *
28939
- * Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it.
28939
+ * Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it. An API key narrowed by `policy_ids` can only set `policy_ids` to a non-empty subset of its own (`403 API_KEY_POLICY_BOUNDARY` otherwise).
28940
28940
  */
28941
28941
  static updateApiKey<ThrowOnError extends boolean = false>(options: Options<UpdateApiKeyData, ThrowOnError>): RequestResult<UpdateApiKeyResponses, UpdateApiKeyErrors, ThrowOnError>;
28942
28942
  }
package/dist/index.mjs CHANGED
@@ -1099,7 +1099,7 @@ var ApiKeys = class {
1099
1099
  /**
1100
1100
  * Create an API key
1101
1101
  *
1102
- * Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped credential**, the new key is confined to that same project: omitting `project_id` defaults to it, naming a different project returns `403 API_KEY_PROJECT_SCOPE`, and `project_id: null` (an unscoped key) is likewise refused. Minting an unscoped key requires an unscoped credential.
1102
+ * Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped). - When the request is authenticated with a **project-scoped credential**, the new key is confined to that same project: omitting `project_id` defaults to it, naming a different project returns `403 API_KEY_PROJECT_SCOPE`, and `project_id: null` (an unscoped key) is likewise refused. Minting an unscoped key requires an unscoped credential. - When the request is authenticated with an **API key narrowed by `policy_ids`**, the new key stays inside that boundary: omitting `policy_ids` inherits the caller's own, a non-empty subset of them is accepted, and an empty list or any other policy returns `403 API_KEY_POLICY_BOUNDARY`.
1103
1103
  *
1104
1104
  */
1105
1105
  static createApiKey(options) {
@@ -1137,7 +1137,7 @@ var ApiKeys = class {
1137
1137
  /**
1138
1138
  * Update an API key
1139
1139
  *
1140
- * Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it.
1140
+ * Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it. A project-scoped credential can only update keys in its own project, and cannot move a key to another project or unscope it. An API key narrowed by `policy_ids` can only set `policy_ids` to a non-empty subset of its own (`403 API_KEY_POLICY_BOUNDARY` otherwise).
1141
1141
  */
1142
1142
  static updateApiKey(options) {
1143
1143
  return (options.client ?? client).put({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@soat/sdk",
3
- "version": "0.95.0",
3
+ "version": "0.96.0",
4
4
  "description": "TypeScript SDK for SOAT — open-source infrastructure for production-ready AI agents.",
5
5
  "keywords": [
6
6
  "ai-agents",