@scenario-labs/sdk 3.2.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) },
     });
   }
 
@@ -36,10 +37,10 @@ export class Search extends APIResource {
   ): PagePromise<SearchModelSearchResponsesSearchHitsOffset, SearchModelSearchResponse> {
     const { originalAssets, projectId, ...body } = params;
     return this._client.getAPIList('/search/models', SearchHitsOffset<SearchModelSearchResponse>, {
-      query: { originalAssets, projectId },
       body,
       method: 'post',
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -53,10 +54,10 @@ export class Search extends APIResource {
   ): PagePromise<SearchWorkflowSearchResponsesSearchHitsOffset, SearchWorkflowSearchResponse> {
     const { originalAssets, projectId, ...body } = params;
     return this._client.getAPIList('/search/workflows', SearchHitsOffset<SearchWorkflowSearchResponse>, {
-      query: { originalAssets, projectId },
       body,
       method: 'post',
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 }

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';

package/src/resources/teams/ip-filters.ts

@@ -0,0 +1,177 @@
+// 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 IPFilters extends APIResource {
+  /**
+   * Create a custom IP-detection filter for a team (built-in filters are toggled via
+   * PUT /teams/{teamId}/ip-filters/{filterId})
+   */
+  create(
+    teamID: string,
+    body: IPFilterCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<IPFilterCreateResponse> {
+    return this._client.post(path`/teams/${teamID}/ip-filters`, { body, ...options });
+  }
+
+  /**
+   * Enable, disable, or override a built-in or custom IP-detection filter for a team
+   */
+  update(
+    filterID: string,
+    params: IPFilterUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<IPFilterUpdateResponse> {
+    const { teamId, ...body } = params;
+    return this._client.put(path`/teams/${teamId}/ip-filters/${filterID}`, { body, ...options });
+  }
+
+  /**
+   * List the built-in and custom IP-detection filters available to a team, with
+   * their enabled state
+   */
+  list(teamID: string, options?: RequestOptions): APIPromise<IPFilterListResponse> {
+    return this._client.get(path`/teams/${teamID}/ip-filters`, options);
+  }
+
+  /**
+   * Delete a custom IP-detection filter for a team
+   */
+  delete(
+    filterID: string,
+    params: IPFilterDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<IPFilterDeleteResponse> {
+    const { teamId } = params;
+    return this._client.delete(path`/teams/${teamId}/ip-filters/${filterID}`, options);
+  }
+
+  /**
+   * Draft a custom IP-detection filter instruction from reference assets (the caller
+   * must have read access to every asset)
+   */
+  draftInstruction(
+    teamID: string,
+    body: IPFilterDraftInstructionParams,
+    options?: RequestOptions,
+  ): APIPromise<IPFilterDraftInstructionResponse> {
+    return this._client.post(path`/teams/${teamID}/ip-filters/draft-instruction`, { body, ...options });
+  }
+}
+
+export interface IPFilterCreateResponse {
+  /**
+   * The created custom filter, including its enabled state
+   */
+  filter: unknown;
+}
+
+export interface IPFilterUpdateResponse {
+  /**
+   * The updated filter, including its enabled state
+   */
+  filter: unknown;
+}
+
+export interface IPFilterListResponse {
+  /**
+   * Built-in and custom IP-detection filters for the team, each with its enabled
+   * state
+   */
+  filters: Array<unknown>;
+}
+
+export interface IPFilterDeleteResponse {
+  /**
+   * True when the filter was deleted
+   */
+  deleted: boolean;
+}
+
+export interface IPFilterDraftInstructionResponse {
+  /**
+   * Drafted natural-language detection instruction derived from the reference assets
+   */
+  instruction: string;
+}
+
+export interface IPFilterCreateParams {
+  /**
+   * Filter category; use "custom" for customer-authored filters
+   */
+  category: 'artist-style' | 'brand-trademark' | 'celebrity-likeness' | 'custom' | 'fictional-character';
+
+  /**
+   * Display name for the filter
+   */
+  name: string;
+
+  /**
+   * Whether the filter is active
+   */
+  enabled?: boolean;
+
+  /**
+   * Natural-language detection instruction (required for custom filters)
+   */
+  instruction?: string;
+
+  /**
+   * Optional reference assets used only to generate the instruction
+   */
+  sourceAssetIds?: Array<string>;
+}
+
+export interface IPFilterUpdateParams {
+  /**
+   * Path param: The team the filter belongs to
+   */
+  teamId: string;
+
+  /**
+   * Body param: Whether the filter is active
+   */
+  enabled?: boolean;
+
+  /**
+   * Body param: Natural-language detection instruction
+   */
+  instruction?: string;
+
+  /**
+   * Body param: Display name for the filter
+   */
+  name?: string;
+}
+
+export interface IPFilterDeleteParams {
+  /**
+   * The team the filter belongs to
+   */
+  teamId: string;
+}
+
+export interface IPFilterDraftInstructionParams {
+  /**
+   * Reference assets whose imagery seeds the drafted detection instruction
+   */
+  assetIds: Array<string>;
+}
+
+export declare namespace IPFilters {
+  export {
+    type IPFilterCreateResponse as IPFilterCreateResponse,
+    type IPFilterUpdateResponse as IPFilterUpdateResponse,
+    type IPFilterListResponse as IPFilterListResponse,
+    type IPFilterDeleteResponse as IPFilterDeleteResponse,
+    type IPFilterDraftInstructionResponse as IPFilterDraftInstructionResponse,
+    type IPFilterCreateParams as IPFilterCreateParams,
+    type IPFilterUpdateParams as IPFilterUpdateParams,
+    type IPFilterDeleteParams as IPFilterDeleteParams,
+    type IPFilterDraftInstructionParams as IPFilterDraftInstructionParams,
+  };
+}