@scenario-labs/sdk 3.2.0 → 3.3.0

package/src/resources/teams/watermark.ts

@@ -0,0 +1,590 @@
+// 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 Watermark extends APIResource {
+  /**
+   * Get the team's forced watermark configuration
+   */
+  retrieve(teamID: string, options?: RequestOptions): APIPromise<WatermarkRetrieveResponse> {
+    return this._client.get(path`/teams/${teamID}/watermark`, options);
+  }
+
+  /**
+   * Create or update the team's forced watermark configuration
+   */
+  update(
+    teamID: string,
+    body: WatermarkUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<WatermarkUpdateResponse> {
+    return this._client.put(path`/teams/${teamID}/watermark`, { body, ...options });
+  }
+
+  /**
+   * Delete the team's forced watermark configuration
+   */
+  delete(teamID: string, options?: RequestOptions): APIPromise<WatermarkDeleteResponse> {
+    return this._client.delete(path`/teams/${teamID}/watermark`, options);
+  }
+
+  /**
+   * Remove the team's watermark logo, falling back to its configured text
+   */
+  deleteLogo(teamID: string, options?: RequestOptions): APIPromise<WatermarkDeleteLogoResponse> {
+    return this._client.delete(path`/teams/${teamID}/watermark/logo`, options);
+  }
+
+  /**
+   * Draw the given watermark settings on a sample image, without saving them
+   */
+  preview(
+    teamID: string,
+    body: WatermarkPreviewParams,
+    options?: RequestOptions,
+  ): APIPromise<WatermarkPreviewResponse> {
+    return this._client.post(path`/teams/${teamID}/watermark/preview`, { body, ...options });
+  }
+
+  /**
+   * Upload the team's watermark logo, used as the mark instead of its text
+   */
+  updateLogo(
+    teamID: string,
+    body: WatermarkUpdateLogoParams,
+    options?: RequestOptions,
+  ): APIPromise<WatermarkUpdateLogoResponse> {
+    return this._client.put(path`/teams/${teamID}/watermark/logo`, { body, ...options });
+  }
+}
+
+export interface WatermarkRetrieveResponse {
+  /**
+   * Forced-watermark configuration stored at one scope.
+   */
+  watermark: WatermarkRetrieveResponse.Watermark;
+}
+
+export namespace WatermarkRetrieveResponse {
+  /**
+   * Forced-watermark configuration stored at one scope.
+   */
+  export interface Watermark {
+    /**
+     * Stable identifier derived from level + scopeId
+     */
+    id: string;
+
+    /**
+     * ISO-8601 creation timestamp
+     */
+    createdAt: string;
+
+    /**
+     * User id that last wrote the configuration
+     */
+    createdBy: string;
+
+    /**
+     * Whether the watermark is enforced on assets generated in this scope. A disabled
+     * project configuration falls back to its team's.
+     */
+    enabled: boolean;
+
+    /**
+     * Scope this configuration applies to: team or project
+     */
+    level: 'project' | 'team';
+
+    /**
+     * Mark opacity, 0.05 (barely visible) to 1 (opaque)
+     */
+    opacity: number;
+
+    /**
+     * Where the mark sits on the image
+     */
+    placement: 'bottom-left' | 'bottom-right' | 'center' | 'tiled' | 'top-left' | 'top-right';
+
+    /**
+     * Mark rotation in degrees, -90 to 90. 0 is horizontal.
+     */
+    rotation: number;
+
+    /**
+     * Mark width as a fraction of the image width
+     */
+    scale: number;
+
+    /**
+     * The id of the team or project that owns this configuration
+     */
+    scopeId: string;
+
+    /**
+     * Gap between repetitions, as a fraction of the mark's own size. Tiled placement
+     * only; 0 repeats the mark edge to edge.
+     */
+    spacing: number;
+
+    /**
+     * ISO-8601 last-update timestamp
+     */
+    updatedAt: string;
+
+    /**
+     * Bumped on every write.
+     */
+    version: number;
+
+    /**
+     * Set when the configuration has been deleted.
+     */
+    deletedAt?: string;
+
+    /**
+     * Whether the stored logo has no transparency at all.
+     *
+     * Recorded at upload so the UI can warn without decoding the image again: an
+     * opaque logo draws its whole rectangle, which a rotated tiled mark turns into a
+     * very visible diamond.
+     */
+    logoIsOpaque?: boolean;
+
+    /**
+     * Where the uploaded logo lives, when one is set.
+     */
+    logoKey?: string;
+
+    /**
+     * Text rendered as the mark, when no logo is set
+     */
+    text?: string;
+  }
+}
+
+export interface WatermarkUpdateResponse {
+  /**
+   * Forced-watermark configuration stored at one scope.
+   */
+  watermark: WatermarkUpdateResponse.Watermark;
+}
+
+export namespace WatermarkUpdateResponse {
+  /**
+   * Forced-watermark configuration stored at one scope.
+   */
+  export interface Watermark {
+    /**
+     * Stable identifier derived from level + scopeId
+     */
+    id: string;
+
+    /**
+     * ISO-8601 creation timestamp
+     */
+    createdAt: string;
+
+    /**
+     * User id that last wrote the configuration
+     */
+    createdBy: string;
+
+    /**
+     * Whether the watermark is enforced on assets generated in this scope. A disabled
+     * project configuration falls back to its team's.
+     */
+    enabled: boolean;
+
+    /**
+     * Scope this configuration applies to: team or project
+     */
+    level: 'project' | 'team';
+
+    /**
+     * Mark opacity, 0.05 (barely visible) to 1 (opaque)
+     */
+    opacity: number;
+
+    /**
+     * Where the mark sits on the image
+     */
+    placement: 'bottom-left' | 'bottom-right' | 'center' | 'tiled' | 'top-left' | 'top-right';
+
+    /**
+     * Mark rotation in degrees, -90 to 90. 0 is horizontal.
+     */
+    rotation: number;
+
+    /**
+     * Mark width as a fraction of the image width
+     */
+    scale: number;
+
+    /**
+     * The id of the team or project that owns this configuration
+     */
+    scopeId: string;
+
+    /**
+     * Gap between repetitions, as a fraction of the mark's own size. Tiled placement
+     * only; 0 repeats the mark edge to edge.
+     */
+    spacing: number;
+
+    /**
+     * ISO-8601 last-update timestamp
+     */
+    updatedAt: string;
+
+    /**
+     * Bumped on every write.
+     */
+    version: number;
+
+    /**
+     * Set when the configuration has been deleted.
+     */
+    deletedAt?: string;
+
+    /**
+     * Whether the stored logo has no transparency at all.
+     *
+     * Recorded at upload so the UI can warn without decoding the image again: an
+     * opaque logo draws its whole rectangle, which a rotated tiled mark turns into a
+     * very visible diamond.
+     */
+    logoIsOpaque?: boolean;
+
+    /**
+     * Where the uploaded logo lives, when one is set.
+     */
+    logoKey?: string;
+
+    /**
+     * Text rendered as the mark, when no logo is set
+     */
+    text?: string;
+  }
+}
+
+export interface WatermarkDeleteResponse {
+  deleted: boolean;
+}
+
+export interface WatermarkDeleteLogoResponse {
+  /**
+   * Forced-watermark configuration stored at one scope.
+   */
+  watermark: WatermarkDeleteLogoResponse.Watermark;
+}
+
+export namespace WatermarkDeleteLogoResponse {
+  /**
+   * Forced-watermark configuration stored at one scope.
+   */
+  export interface Watermark {
+    /**
+     * Stable identifier derived from level + scopeId
+     */
+    id: string;
+
+    /**
+     * ISO-8601 creation timestamp
+     */
+    createdAt: string;
+
+    /**
+     * User id that last wrote the configuration
+     */
+    createdBy: string;
+
+    /**
+     * Whether the watermark is enforced on assets generated in this scope. A disabled
+     * project configuration falls back to its team's.
+     */
+    enabled: boolean;
+
+    /**
+     * Scope this configuration applies to: team or project
+     */
+    level: 'project' | 'team';
+
+    /**
+     * Mark opacity, 0.05 (barely visible) to 1 (opaque)
+     */
+    opacity: number;
+
+    /**
+     * Where the mark sits on the image
+     */
+    placement: 'bottom-left' | 'bottom-right' | 'center' | 'tiled' | 'top-left' | 'top-right';
+
+    /**
+     * Mark rotation in degrees, -90 to 90. 0 is horizontal.
+     */
+    rotation: number;
+
+    /**
+     * Mark width as a fraction of the image width
+     */
+    scale: number;
+
+    /**
+     * The id of the team or project that owns this configuration
+     */
+    scopeId: string;
+
+    /**
+     * Gap between repetitions, as a fraction of the mark's own size. Tiled placement
+     * only; 0 repeats the mark edge to edge.
+     */
+    spacing: number;
+
+    /**
+     * ISO-8601 last-update timestamp
+     */
+    updatedAt: string;
+
+    /**
+     * Bumped on every write.
+     */
+    version: number;
+
+    /**
+     * Set when the configuration has been deleted.
+     */
+    deletedAt?: string;
+
+    /**
+     * Whether the stored logo has no transparency at all.
+     *
+     * Recorded at upload so the UI can warn without decoding the image again: an
+     * opaque logo draws its whole rectangle, which a rotated tiled mark turns into a
+     * very visible diamond.
+     */
+    logoIsOpaque?: boolean;
+
+    /**
+     * Where the uploaded logo lives, when one is set.
+     */
+    logoKey?: string;
+
+    /**
+     * Text rendered as the mark, when no logo is set
+     */
+    text?: string;
+  }
+}
+
+/**
+ * Response of the watermark preview routes.
+ */
+export interface WatermarkPreviewResponse {
+  /**
+   * The sample image with the mark drawn on it, base64-encoded.
+   */
+  image: string;
+}
+
+export interface WatermarkUpdateLogoResponse {
+  /**
+   * Forced-watermark configuration stored at one scope.
+   */
+  watermark: WatermarkUpdateLogoResponse.Watermark;
+}
+
+export namespace WatermarkUpdateLogoResponse {
+  /**
+   * Forced-watermark configuration stored at one scope.
+   */
+  export interface Watermark {
+    /**
+     * Stable identifier derived from level + scopeId
+     */
+    id: string;
+
+    /**
+     * ISO-8601 creation timestamp
+     */
+    createdAt: string;
+
+    /**
+     * User id that last wrote the configuration
+     */
+    createdBy: string;
+
+    /**
+     * Whether the watermark is enforced on assets generated in this scope. A disabled
+     * project configuration falls back to its team's.
+     */
+    enabled: boolean;
+
+    /**
+     * Scope this configuration applies to: team or project
+     */
+    level: 'project' | 'team';
+
+    /**
+     * Mark opacity, 0.05 (barely visible) to 1 (opaque)
+     */
+    opacity: number;
+
+    /**
+     * Where the mark sits on the image
+     */
+    placement: 'bottom-left' | 'bottom-right' | 'center' | 'tiled' | 'top-left' | 'top-right';
+
+    /**
+     * Mark rotation in degrees, -90 to 90. 0 is horizontal.
+     */
+    rotation: number;
+
+    /**
+     * Mark width as a fraction of the image width
+     */
+    scale: number;
+
+    /**
+     * The id of the team or project that owns this configuration
+     */
+    scopeId: string;
+
+    /**
+     * Gap between repetitions, as a fraction of the mark's own size. Tiled placement
+     * only; 0 repeats the mark edge to edge.
+     */
+    spacing: number;
+
+    /**
+     * ISO-8601 last-update timestamp
+     */
+    updatedAt: string;
+
+    /**
+     * Bumped on every write.
+     */
+    version: number;
+
+    /**
+     * Set when the configuration has been deleted.
+     */
+    deletedAt?: string;
+
+    /**
+     * Whether the stored logo has no transparency at all.
+     *
+     * Recorded at upload so the UI can warn without decoding the image again: an
+     * opaque logo draws its whole rectangle, which a rotated tiled mark turns into a
+     * very visible diamond.
+     */
+    logoIsOpaque?: boolean;
+
+    /**
+     * Where the uploaded logo lives, when one is set.
+     */
+    logoKey?: string;
+
+    /**
+     * Text rendered as the mark, when no logo is set
+     */
+    text?: string;
+  }
+}
+
+export interface WatermarkUpdateParams {
+  /**
+   * Whether the watermark is enforced on assets generated in this scope. A disabled
+   * project configuration falls back to its team's.
+   */
+  enabled: boolean;
+
+  /**
+   * Mark opacity, 0.05 (barely visible) to 1 (opaque)
+   */
+  opacity?: number;
+
+  /**
+   * Where the mark sits on the image
+   */
+  placement?: 'bottom-left' | 'bottom-right' | 'center' | 'tiled' | 'top-left' | 'top-right';
+
+  /**
+   * Mark rotation in degrees. 0 is horizontal, negative tilts it up.
+   */
+  rotation?: number;
+
+  /**
+   * Mark width as a fraction of the image width
+   */
+  scale?: number;
+
+  /**
+   * Gap between repetitions, as a fraction of the mark's own size. Only drawn for
+   * the tiled placement; 0 repeats the mark edge to edge.
+   */
+  spacing?: number;
+
+  /**
+   * Text rendered as the mark. Ignored while a logo is set.
+   */
+  text?: string;
+}
+
+export interface WatermarkPreviewParams {
+  /**
+   * Mark opacity, 0.05 (barely visible) to 1 (opaque)
+   */
+  opacity?: number;
+
+  /**
+   * Where the mark sits on the image
+   */
+  placement?: 'bottom-left' | 'bottom-right' | 'center' | 'tiled' | 'top-left' | 'top-right';
+
+  /**
+   * Mark rotation in degrees. 0 is horizontal, negative tilts it up.
+   */
+  rotation?: number;
+
+  /**
+   * Mark width as a fraction of the image width
+   */
+  scale?: number;
+
+  /**
+   * Gap between repetitions, as a fraction of the mark's own size. Only drawn for
+   * the tiled placement; 0 repeats the mark edge to edge.
+   */
+  spacing?: number;
+
+  /**
+   * Text to draw. Optional only because a logo can stand in for it.
+   */
+  text?: string;
+}
+
+export interface WatermarkUpdateLogoParams {
+  /**
+   * The logo image, base64-encoded, at most 1 MB and 4 megapixels once decoded. PNG,
+   * JPEG and WebP are accepted; SVG is refused. Stored as PNG.
+   */
+  logo: string;
+}
+
+export declare namespace Watermark {
+  export {
+    type WatermarkRetrieveResponse as WatermarkRetrieveResponse,
+    type WatermarkUpdateResponse as WatermarkUpdateResponse,
+    type WatermarkDeleteResponse as WatermarkDeleteResponse,
+    type WatermarkDeleteLogoResponse as WatermarkDeleteLogoResponse,
+    type WatermarkPreviewResponse as WatermarkPreviewResponse,
+    type WatermarkUpdateLogoResponse as WatermarkUpdateLogoResponse,
+    type WatermarkUpdateParams as WatermarkUpdateParams,
+    type WatermarkPreviewParams as WatermarkPreviewParams,
+    type WatermarkUpdateLogoParams as WatermarkUpdateLogoParams,
+  };
+}