@scenario-labs/sdk 3.1.0 → 3.3.0

package/src/resources/search.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../core/resource';
 import { PagePromise, SearchHitsOffset, type SearchHitsOffsetParams } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
+import { omitUndefined } from '../internal/utils/values';
 
 export class Search extends APIResource {
   /**
@@ -17,10 +18,10 @@ export class Search extends APIResource {
   ): PagePromise<SearchAssetSearchResponsesSearchHitsOffset, SearchAssetSearchResponse> {
     const { originalAssets, projectId, ...body } = params;
     return this._client.getAPIList('/search/assets', SearchHitsOffset<SearchAssetSearchResponse>, {
-      query: { originalAssets, projectId },
       body,
       method: 'post',
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -34,12 +35,29 @@ export class Search extends APIResource {
     params: SearchModelSearchParams,
     options?: RequestOptions,
   ): PagePromise<SearchModelSearchResponsesSearchHitsOffset, SearchModelSearchResponse> {
-    const { originalAssets, originalModels, projectId, ...body } = params;
+    const { originalAssets, projectId, ...body } = params;
     return this._client.getAPIList('/search/models', SearchHitsOffset<SearchModelSearchResponse>, {
-      query: { originalAssets, originalModels, projectId },
       body,
       method: 'post',
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
+    });
+  }
+
+  /**
+   * Search for workflows. At least one of the following fields must have a value:
+   * `query` or `filter`.
+   */
+  workflowSearch(
+    params: SearchWorkflowSearchParams,
+    options?: RequestOptions,
+  ): PagePromise<SearchWorkflowSearchResponsesSearchHitsOffset, SearchWorkflowSearchResponse> {
+    const { originalAssets, projectId, ...body } = params;
+    return this._client.getAPIList('/search/workflows', SearchHitsOffset<SearchWorkflowSearchResponse>, {
+      body,
+      method: 'post',
+      ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 }
@@ -48,6 +66,8 @@ export type SearchAssetSearchResponsesSearchHitsOffset = SearchHitsOffset<Search
 
 export type SearchModelSearchResponsesSearchHitsOffset = SearchHitsOffset<SearchModelSearchResponse>;
 
+export type SearchWorkflowSearchResponsesSearchHitsOffset = SearchHitsOffset<SearchWorkflowSearchResponse>;
+
 export interface SearchAssetSearchResponse {
   /**
    * Unique identifier for the asset (e.g., "asset_GTrL3mq4SXWyMxkOHRxlpw")
@@ -413,6 +433,141 @@ export namespace SearchModelSearchResponse {
   }
 }
 
+export interface SearchWorkflowSearchResponse {
+  /**
+   * Unique identifier for the workflow (e.g., "workflow_abc123")
+   */
+  id: string;
+
+  /**
+   * User ID of the workflow creator/author
+   */
+  authorId: string;
+
+  /**
+   * Array of collection IDs this workflow belongs to
+   */
+  collectionIds: Array<string>;
+
+  /**
+   * Creation timestamp in ISO 8601 format (e.g., "2025-01-16T11:19:41.579Z")
+   */
+  createdAt: string;
+
+  /**
+   * Full description of the workflow
+   */
+  description: string;
+
+  /**
+   * Display name of the workflow
+   */
+  name: string;
+
+  /**
+   * Project ID of the workflow owner
+   */
+  ownerId: string;
+
+  /**
+   * Privacy setting of the workflow ("public", "private", or "unlisted")
+   */
+  privacy: string;
+
+  /**
+   * Status of the workflow (e.g., "ready", "draft", "deleted")
+   */
+  status: string;
+
+  /**
+   * Array of user-assigned tags for categorization
+   */
+  tags: Array<string>;
+
+  /**
+   * Team ID of the workflow owner
+   */
+  teamId: string;
+
+  /**
+   * Last modification timestamp in ISO 8601 format (e.g.,
+   * "2025-01-16T11:19:41.579Z")
+   */
+  updatedAt: string;
+
+  /**
+   * After image information for the workflow
+   */
+  after?: SearchWorkflowSearchResponse.After;
+
+  /**
+   * Before image information for the workflow
+   */
+  before?: SearchWorkflowSearchResponse.Before;
+
+  /**
+   * Score assigned to the workflow based on usage and popularity
+   */
+  score?: number;
+
+  /**
+   * Short description of the workflow
+   */
+  shortDescription?: string;
+
+  /**
+   * Thumbnail image information for the workflow
+   */
+  thumbnail?: SearchWorkflowSearchResponse.Thumbnail;
+}
+
+export namespace SearchWorkflowSearchResponse {
+  /**
+   * After image information for the workflow
+   */
+  export interface After {
+    /**
+     * ID of the asset used as after image
+     */
+    assetId: string;
+
+    /**
+     * Signed URL of the after image
+     */
+    url: string;
+  }
+
+  /**
+   * Before image information for the workflow
+   */
+  export interface Before {
+    /**
+     * ID of the asset used as before image
+     */
+    assetId: string;
+
+    /**
+     * Signed URL of the before image
+     */
+    url: string;
+  }
+
+  /**
+   * Thumbnail image information for the workflow
+   */
+  export interface Thumbnail {
+    /**
+     * ID of the asset used as thumbnail
+     */
+    assetId: string;
+
+    /**
+     * Signed URL of the thumbnail
+     */
+    url: string;
+  }
+}
+
 export interface SearchAssetSearchParams extends SearchHitsOffsetParams {
   /**
    * Query param: If set to true, returns the original asset without transformation
@@ -522,11 +677,6 @@ export interface SearchModelSearchParams extends SearchHitsOffsetParams {
    */
   originalAssets?: boolean;
 
-  /**
-   * Query param
-   */
-  originalModels?: unknown;
-
   /**
    * Query param: The projectId used for ownership resource management. Either to
    * assert ownership or to set the owner of the resource(s)
@@ -624,13 +774,75 @@ export namespace SearchModelSearchParams {
   }
 }
 
+export interface SearchWorkflowSearchParams extends SearchHitsOffsetParams {
+  /**
+   * Query param: If set to true, returns the original asset without transformation
+   */
+  originalAssets?: boolean;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
+  /**
+   * Body param: Filter queries by an attribute's value
+   */
+  filter?: string;
+
+  /**
+   * Body param: Maximum number of documents returned for a page. Must be used with
+   * `page`.
+   */
+  hitsPerPage?: number;
+
+  /**
+   * Body param: Maximum number of documents returned. Must be used with `offset`.
+   */
+  limit?: number;
+
+  /**
+   * Body param: Request a specific page of results. Must be used with `hitsPerPage`.
+   */
+  page?: number;
+
+  /**
+   * Body param: Search for public workflows not necessarily belonging to the current
+   * `ownerId`
+   */
+  public?: boolean;
+
+  /**
+   * Body param: A string used for querying search results.
+   */
+  query?: string;
+
+  /**
+   * Body param: Query embedding for hybrid search, if possible
+   */
+  querySemanticRatio?: number;
+
+  /**
+   * Body param: Sort the search results by the given attributes. Each attribute in
+   * the list must be followed by a colon (`:`) and the preferred sorting order:
+   * either ascending (`asc`) or descending (`desc`).
+   *
+   * Example: `['createdAt:desc']`
+   */
+  sortBy?: Array<string>;
+}
+
 export declare namespace Search {
   export {
     type SearchAssetSearchResponse as SearchAssetSearchResponse,
     type SearchModelSearchResponse as SearchModelSearchResponse,
+    type SearchWorkflowSearchResponse as SearchWorkflowSearchResponse,
     type SearchAssetSearchResponsesSearchHitsOffset as SearchAssetSearchResponsesSearchHitsOffset,
     type SearchModelSearchResponsesSearchHitsOffset as SearchModelSearchResponsesSearchHitsOffset,
+    type SearchWorkflowSearchResponsesSearchHitsOffset as SearchWorkflowSearchResponsesSearchHitsOffset,
     type SearchAssetSearchParams as SearchAssetSearchParams,
     type SearchModelSearchParams as SearchModelSearchParams,
+    type SearchWorkflowSearchParams as SearchWorkflowSearchParams,
   };
 }

package/src/resources/tags.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../core/resource';
 import { PagePromise, TagsCursor, type TagsCursorParams } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
+import { omitUndefined } from '../internal/utils/values';
 
 export class Tags extends APIResource {
   /**
@@ -12,7 +13,10 @@ export class Tags extends APIResource {
     query: TagListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<TagListResponsesTagsCursor, TagListResponse> {
-    return this._client.getAPIList('/tags', TagsCursor<TagListResponse>, { query, ...options });
+    return this._client.getAPIList('/tags', TagsCursor<TagListResponse>, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
   }
 }
 

package/src/resources/teams/brief.ts

@@ -0,0 +1,193 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Brief extends APIResource {
+  /**
+   * Get the team's Quality Gate brief
+   */
+  retrieve(teamID: string, options?: RequestOptions): APIPromise<BriefRetrieveResponse> {
+    return this._client.get(path`/teams/${teamID}/brief`, options);
+  }
+
+  /**
+   * Create or update the team's Quality Gate brief
+   */
+  update(teamID: string, body: BriefUpdateParams, options?: RequestOptions): APIPromise<BriefUpdateResponse> {
+    return this._client.put(path`/teams/${teamID}/brief`, { body, ...options });
+  }
+
+  /**
+   * Delete the team's Quality Gate brief
+   */
+  delete(teamID: string, options?: RequestOptions): APIPromise<BriefDeleteResponse> {
+    return this._client.delete(path`/teams/${teamID}/brief`, options);
+  }
+}
+
+export interface BriefRetrieveResponse {
+  /**
+   * A brand-style / project-rules / campaign-context brief stored at one scope.
+   */
+  brief: BriefRetrieveResponse.Brief;
+}
+
+export namespace BriefRetrieveResponse {
+  /**
+   * A brand-style / project-rules / campaign-context brief stored at one scope.
+   */
+  export interface Brief {
+    /**
+     * Stable identifier derived from level + scopeId
+     */
+    id: string;
+
+    /**
+     * Free-text brief: brand style, rules, campaign context
+     */
+    body: string;
+
+    /**
+     * ISO-8601 creation timestamp
+     */
+    createdAt: string;
+
+    /**
+     * User id that last wrote the brief
+     */
+    createdBy: string;
+
+    /**
+     * Whether the brief is applied during verification
+     */
+    enabled: boolean;
+
+    /**
+     * Scope this brief applies to: team or project
+     */
+    level: 'project' | 'team';
+
+    /**
+     * Reference assets the verifier compares the image against
+     */
+    referenceAssetIds: Array<string>;
+
+    /**
+     * The id of the team or project that owns this brief
+     */
+    scopeId: string;
+
+    /**
+     * ISO-8601 last-update timestamp
+     */
+    updatedAt: string;
+
+    /**
+     * Threshold strictness applied when verifying against this scope
+     */
+    sensitivity?: 'high' | 'low' | 'medium';
+  }
+}
+
+export interface BriefUpdateResponse {
+  /**
+   * A brand-style / project-rules / campaign-context brief stored at one scope.
+   */
+  brief: BriefUpdateResponse.Brief;
+}
+
+export namespace BriefUpdateResponse {
+  /**
+   * A brand-style / project-rules / campaign-context brief stored at one scope.
+   */
+  export interface Brief {
+    /**
+     * Stable identifier derived from level + scopeId
+     */
+    id: string;
+
+    /**
+     * Free-text brief: brand style, rules, campaign context
+     */
+    body: string;
+
+    /**
+     * ISO-8601 creation timestamp
+     */
+    createdAt: string;
+
+    /**
+     * User id that last wrote the brief
+     */
+    createdBy: string;
+
+    /**
+     * Whether the brief is applied during verification
+     */
+    enabled: boolean;
+
+    /**
+     * Scope this brief applies to: team or project
+     */
+    level: 'project' | 'team';
+
+    /**
+     * Reference assets the verifier compares the image against
+     */
+    referenceAssetIds: Array<string>;
+
+    /**
+     * The id of the team or project that owns this brief
+     */
+    scopeId: string;
+
+    /**
+     * ISO-8601 last-update timestamp
+     */
+    updatedAt: string;
+
+    /**
+     * Threshold strictness applied when verifying against this scope
+     */
+    sensitivity?: 'high' | 'low' | 'medium';
+  }
+}
+
+export interface BriefDeleteResponse {
+  deleted: boolean;
+}
+
+export interface BriefUpdateParams {
+  /**
+   * Free-text brief content
+   */
+  body: string;
+
+  /**
+   * Whether the brief is applied during verification (default true)
+   */
+  enabled?: boolean;
+
+  /**
+   * Reference assets the verifier compares against (max 10). Send [] to clear.
+   */
+  referenceAssetIds?: Array<string>;
+
+  /**
+   * Threshold strictness stored for this scope: low, medium, or high. Applied to
+   * verifications unless the verify call passes its own sensitivity.
+   */
+  sensitivity?: 'high' | 'low' | 'medium';
+}
+
+export declare namespace Brief {
+  export {
+    type BriefRetrieveResponse as BriefRetrieveResponse,
+    type BriefUpdateResponse as BriefUpdateResponse,
+    type BriefDeleteResponse as BriefDeleteResponse,
+    type BriefUpdateParams as BriefUpdateParams,
+  };
+}

package/src/resources/teams/index.ts

@@ -0,0 +1,62 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Brief,
+  type BriefRetrieveResponse,
+  type BriefUpdateResponse,
+  type BriefDeleteResponse,
+  type BriefUpdateParams,
+} from './brief';
+export {
+  IPFilters,
+  type IPFilterCreateResponse,
+  type IPFilterUpdateResponse,
+  type IPFilterListResponse,
+  type IPFilterDeleteResponse,
+  type IPFilterDraftInstructionResponse,
+  type IPFilterCreateParams,
+  type IPFilterUpdateParams,
+  type IPFilterDeleteParams,
+  type IPFilterDraftInstructionParams,
+} from './ip-filters';
+export {
+  Members,
+  type MemberCreateResponse,
+  type MemberUpdateResponse,
+  type MemberDeleteResponse,
+  type MemberCreateParams,
+  type MemberUpdateParams,
+  type MemberDeleteParams,
+} from './members';
+export {
+  Teams,
+  type TeamRetrieveResponse,
+  type TeamUpdateResponse,
+  type TeamListResponse,
+  type TeamDeleteInvitationsResponse,
+  type TeamRetrieveLimitsResponse,
+  type TeamUpdateParams,
+  type TeamDeleteInvitationsParams,
+} from './teams';
+export {
+  Watermark,
+  type WatermarkRetrieveResponse,
+  type WatermarkUpdateResponse,
+  type WatermarkDeleteResponse,
+  type WatermarkDeleteLogoResponse,
+  type WatermarkPreviewResponse,
+  type WatermarkUpdateLogoResponse,
+  type WatermarkUpdateParams,
+  type WatermarkPreviewParams,
+  type WatermarkUpdateLogoParams,
+} from './watermark';
+export {
+  WebhookEndpoints,
+  type WebhookEndpointCreateResponse,
+  type WebhookEndpointUpdateResponse,
+  type WebhookEndpointListResponse,
+  type WebhookEndpointDeleteResponse,
+  type WebhookEndpointCreateParams,
+  type WebhookEndpointUpdateParams,
+  type WebhookEndpointDeleteParams,
+} from './webhook-endpoints/index';