calmlens 0.19.0 → 0.21.0

data/sig/calmlens.rbs

@@ -121,6 +121,7 @@ module CalmLens
     attr_reader upload_tokens: UploadTokens
     attr_reader events: Events
     attr_reader cdn: CDN
+    attr_reader lenses: Lenses
     attr_reader project_id: String
     attr_reader base_url: String
     attr_reader cdn_base_url: String
@@ -148,16 +149,12 @@ module CalmLens
   end
 
   class Assets < Resource
-    # The moderation status before a decision.
-    PENDING_MODERATION_STATUS: String
-    # Processing statuses after which no decision arrives without a retry.
-    FINISHED_PROCESSING_STATUSES: Array[String]
+    # The classification statuses of a settled asset; wait_for_decision returns at the first.
+    SETTLED_STATUSES: Array[String]
     DECISION_POLL_FIRST_DELAY: Float
     DECISION_POLL_FACTOR: Float
     DECISION_POLL_MAX_DELAY: Float
     DEFAULT_DECISION_TIMEOUT: Integer
-    DEFAULT_SIGNED_URL_SECONDS: Integer
-    MAX_SIGNED_URL_SECONDS: Integer
     BATCH_OPERATIONS: Array[asset_batch_operation]
     MAX_BATCH_ASSETS: Integer
 
@@ -168,24 +165,30 @@ module CalmLens
     def list_children: (list_asset_children_options options) -> asset_page
     def each_child: (list_asset_children_options options) { (asset) -> void } -> nil
                   | (list_asset_children_options options) -> Enumerator[asset, nil]
+    def list_timeline: (list_asset_timeline_options options) -> asset_timeline_page
+    def each_timeline_segment: (list_asset_timeline_options options) { (media_segment) -> void } -> nil
+                             | (list_asset_timeline_options options) -> Enumerator[media_segment, nil]
     def retrieve: (asset_id_options options) -> asset
     def wait_for_decision: (wait_for_decision_options options) -> asset
     def update: (update_asset_options options) -> asset
     def retry: (asset_id_options options) -> asset
     def decide: (decide_asset_options options) -> asset
     def explain: (explain_asset_options options) -> asset
-    def delete_content: (asset_id_options options) -> asset
+    def remove_content: (asset_id_options options) -> asset
     def delete: (asset_id_options options) -> nil
     def batch: (batch_assets_options options) -> batch_assets_response
     def move: (move_asset_options options) -> asset
-    def create_signed_url: (create_signed_url_options options) -> signed_url
     def create: (upload_options options) -> asset
     def classify: (upload_options options) -> asset
     def upload_part: (upload_part_options options) -> asset
+    # Waits between decision checks; a mock client's waits take no real time.
+    private def sleep: (Numeric seconds) -> void
   end
 
   class Folders < Resource
     def list: (?list_folders_options options) -> folder_page
+    def each: (?list_folders_options options) { (folder) -> void } -> nil
+            | (?list_folders_options options) -> Enumerator[folder, nil]
     def create: (create_folder_options options) -> folder
     def retrieve: (folder_id_options options) -> folder
     def update: (update_folder_options options) -> folder
@@ -195,26 +198,45 @@ module CalmLens
 
   class HashLists < Resource
     def list: (?list_hash_lists_options options) -> hash_list_page
+    def each: (?list_hash_lists_options options) { (hash_list) -> void } -> nil
+            | (?list_hash_lists_options options) -> Enumerator[hash_list, nil]
     def retrieve: (hash_list_id_options options) -> hash_list
     def create: (create_hash_list_options options) -> hash_list
     def update: (update_hash_list_options options) -> hash_list
     def delete: (hash_list_id_options options) -> nil
     def list_entries: (list_hash_list_entries_options options) -> hash_list_entry_page
+    def each_entry: (list_hash_list_entries_options options) { (hash_list_entry) -> void } -> nil
+                  | (list_hash_list_entries_options options) -> Enumerator[hash_list_entry, nil]
     def add_entry: (add_hash_list_entry_options options) -> hash_list_entry
     def remove_entry: (hash_list_entry_id_options options) -> nil
   end
 
   class Policies < Resource
-    def list: (?list_policies_options options) -> policy_list
+    def list: (?list_policies_options options) -> policy_page
+    def each: (?list_policies_options options) { (policy) -> void } -> nil
+            | (?list_policies_options options) -> Enumerator[policy, nil]
     def retrieve: (policy_id_options options) -> policy
+    # The policy the project moderates with.
+    def retrieve_assigned: (?request_only_options options) -> policy
     def create: (create_policy_options options) -> policy
     def update: (update_policy_options options) -> policy
-    def apply_preset: (apply_policy_preset_options options) -> policy
+    def reset: (restore_policy_options options) -> policy
+    def upgrade: (restore_policy_options options) -> policy
     def set_automatic_updates: (set_policy_automatic_updates_options options) -> policy
     def delete: (policy_id_options options) -> nil
     def assign: (assign_policy_options options) -> policy
   end
 
+  class Lenses < Resource
+    def list: (?list_lenses_options options) -> lens_page
+    def each: (?list_lenses_options options) { (lens) -> void } -> nil
+            | (?list_lenses_options options) -> Enumerator[lens, nil]
+    def create: (create_lens_options options) -> lens
+    def retrieve: (lens_id_options options) -> lens
+    def update: (update_lens_options options) -> lens
+    def delete: (lens_id_options options) -> nil
+  end
+
   class UploadTokens < Resource
     TOKEN_PREFIX: String
     SIGNING_CONTEXT: String
@@ -238,7 +260,19 @@ module CalmLens
   end
 
   class CDN < Resource
+    # Every CDN resource beneath an asset URL.
+    RESOURCES: Array[cdn_resource]
+    # A signed asset URL's lifetime in seconds when `expires_in` is omitted.
+    DEFAULT_SIGNED_URL_EXPIRES_IN: Integer
+    # The longest signed asset URL lifetime, in seconds.
+    MAX_SIGNED_URL_EXPIRES_IN: Integer
+    # The start of the asset segment that names an asset by its external ID.
+    EXTERNAL_ID_PREFIX: String
+    # The ISO 3166-1 alpha-2 countries a viewer's `region` can be.
+    VIEWER_COUNTRIES: Array[String]
     def get_asset_url: (asset_url_options options) -> String
+    def sign_asset_url: (sign_asset_url_options options) -> signed_asset_url
+    def get_asset_info: (String url, ?viewer_claims: viewer_claims?) -> asset_info
     def serve: (serve_options options) -> Response
              | [T] (serve_options options) { (Response) -> T } -> T
   end
@@ -247,12 +281,16 @@ module CalmLens
   class WebhookEvent < Struct[untyped]
     attr_accessor id: String
     attr_accessor project_id: String
+    # nil for a delivery without one.
+    attr_accessor actor: actor?
     # New types may appear: ignore unknown ones.
     attr_accessor type: event_type | String
     attr_accessor severity: event_severity?
     attr_accessor title: String?
     attr_accessor description: String?
     attr_accessor asset_id: String?
+    # Increases with each event about the same asset; nil for events not about an asset.
+    attr_accessor asset_sequence: Integer?
     attr_accessor asset: event_asset?
     attr_accessor facts: Array[event_fact]
     # Milliseconds since the Unix epoch.
@@ -260,9 +298,10 @@ module CalmLens
     # The delivery body as received, with every field.
     attr_accessor payload: Hash[String, json_value]
     def initialize: (?id: String, ?project_id: String, ?type: event_type | String, ?severity: event_severity?, ?title: String?,
-                     ?description: String?, ?asset_id: String?, ?asset: event_asset?, ?facts: Array[event_fact],
+                     ?description: String?, ?asset_id: String?, ?asset_sequence: Integer?, ?asset: event_asset?, ?facts: Array[event_fact],
                      ?created_at: Integer, ?payload: Hash[String, json_value]) -> void
     def test?: () -> bool
+    def newer_than?: (Integer? last_sequence) -> bool
     # The delivery body as received, with every field.
     def to_payload: () -> Hash[String, json_value]
   end
@@ -286,6 +325,16 @@ module CalmLens
     def self.parse_event: (payload: String, secret: String, ?signature: String?, ?timestamp: String?, ?headers: webhook_headers?,
                            ?tolerance_seconds: Integer, ?now: number) -> WebhookEvent
     def self.test_event?: (WebhookEvent | Hash[String, untyped] event) -> bool
+    def self.newer_asset_event?: (WebhookEvent | Hash[String, untyped] event, Integer? last_sequence) -> bool
+  # The value of an event's fact by key (the first, when the event repeats it), or nil without one.
+  def self.get_event_fact: (WebhookEvent | Hash[String, untyped] event, String key) -> event_fact_value
+  # An event's facts as values by key; a repeated key keeps its first value.
+  def self.get_event_facts: (WebhookEvent | Hash[String, untyped] event) -> Hash[String, event_fact_value]
+  end
+
+  module EventFacts
+    def self.value: (WebhookEvent | Hash[String, untyped] event, String key) -> event_fact_value
+    def self.values: (WebhookEvent | Hash[String, untyped] event) -> Hash[String, event_fact_value]
   end
 
   def self.create_webhook_signature_header: (payload: String, timestamp: String | Integer, secret: String) -> String
@@ -298,6 +347,11 @@ module CalmLens
   def self.parse_webhook_event: (payload: String, secret: String, ?signature: String?, ?timestamp: String?,
                                  ?headers: webhook_headers?, ?tolerance_seconds: Integer, ?now: number) -> WebhookEvent
   def self.test_webhook_event?: (WebhookEvent | Hash[String, untyped] event) -> bool
+  def self.newer_asset_event?: (WebhookEvent | Hash[String, untyped] event, Integer? last_sequence) -> bool
+  # The value of an event's fact by key (the first, when the event repeats it), or nil without one.
+  def self.get_event_fact: (WebhookEvent | Hash[String, untyped] event, String key) -> event_fact_value
+  # An event's facts as values by key; a repeated key keeps its first value.
+  def self.get_event_facts: (WebhookEvent | Hash[String, untyped] event) -> Hash[String, event_fact_value]
 
   # require 'calmlens/testing'
   module Testing
@@ -357,7 +411,8 @@ module CalmLens
     # Replaces the mock API key's grants for later requests; the key stays the same.
     def api_key_grants=: (Array[Hash[Symbol | String, untyped]] grants) -> Array[Hash[Symbol | String, untyped]]
     # Fails the next request (or the next one `operation` sends) with `transport-error`, `timeout`, an
-    # API error code (with optional `details` and `Retry-After` seconds) or an exception.
+    # API error code (with optional `details` and `Retry-After` seconds, which only an API error takes) or
+    # an exception.
     def fail_next_request: (?(String | Exception) failure, ?operation: String?, ?details: Hash[String | Symbol, untyped]?,
                             ?retry_after: Integer?) -> self
     def state: () -> Testing::State
@@ -365,6 +420,8 @@ module CalmLens
     def enqueue: (body: json_input, ?status: Integer, ?headers: Hash[String, String]) -> self
     def enqueue_raw: (body: String, ?status: Integer, ?headers: Hash[String, String]) -> self
     def enqueue_error: (Exception error) -> self
+    # Fetches a mock CDN URL with a GET and without the API key, as a browser would.
+    def fetch_cdn: (String url) -> Response
     def enqueue_event: (mock_event_input event) -> event
     # Applies a reviewer's decision and adds the matching `asset.<decision>` event.
     def decide: (String asset_id, asset_moderation_decision decision) -> asset
@@ -415,6 +472,12 @@ module CalmLens
     QUALIFIERS: Hash[String, Array[String]]
     # Qualifiers the input type sets, which a TestInputs scenario cannot list.
     INPUT_QUALIFIERS: Array[String]
+    # Test scenario detections: entries per list, the basis points of a full side, the oldest age
+    # and the age presets.
+    TEST_DETECTIONS_MAX: Integer
+    TEST_DETECTION_BOX_MAX: Integer
+    TEST_FACE_AGE_MAX: Integer
+    TEST_FACE_AGE_PRESETS: Array[String]
   end
 
   # Signed test inputs: text codes, test images and media phrases signed with a project's secret
@@ -425,9 +488,20 @@ module CalmLens
     type regional_action = { "region" => region, "action" => "limit" | "age-restrict" | "block" }
     # One qualifying instance; set an action on every instance or on none.
     type test_instance = { "category" => classification_category, ?"score" => number, ?"action" => action, "qualifiers" => Array[String] }
+    # `[left, top, width, height]`: Integers in basis points of the image, 0 to 10000, inside it.
+    type detection_box = [Integer, Integer, Integer, Integer]
+    # A person a test image reports, with an optional Integer confidence from 0 to 100.
+    type test_person = { "box" => detection_box, ?"confidence" => Integer }
+    # A face's age: a preset, or a range of Integers from 0 to 120 with `low` at most `high`.
+    type test_face_age = "adult" | "minor" | { "low" => Integer, "high" => Integer }
+    # A face a test image reports, with an optional confidence and age.
+    type test_face = { "box" => detection_box, ?"confidence" => Integer, ?"age" => test_face_age }
+    # The people and faces a test image reports: at most 32 of each, or `unavailable` to report the
+    # feature as not evaluated.
+    type test_detections = { ?"people" => Array[test_person] | "unavailable", ?"faces" => Array[test_face] | "unavailable" }
     # A scenario with String keys; Symbol and snake_case keys are accepted as a plain Hash.
     type scenario = { ?"regionalActions" => Array[regional_action], ?"unassessedCategories" => Array[classification_category],
-                      "instances" => Array[test_instance] }
+                      "instances" => Array[test_instance], ?"detections" => test_detections }
     type signal = classification_category | "sexual.involving-minors" | "harassment.insult" | "sexual.adult"
                 | "hate.regional-symbol" | "violence.graphic"
     type media_signal = classification_category | "violence.graphic"
@@ -446,7 +520,8 @@ module CalmLens
     REGIONS: Array[region]
     SIGNALS: Array[signal]
     MEDIA_SIGNALS: Array[media_signal]
-    # clean, limited, adult_image, adult_text, regional_delivery, germany and mixed (deeply frozen).
+    # clean, limited, adult_image, adult_text, regional_delivery, germany, mixed, one_face, no_face,
+    # adult_face, minor_face and group (deeply frozen).
     PRESETS: Hash[Symbol, scenario]
 
     def self.for_signal: (signal signal, ?("text" | "image") kind) -> scenario

data/sig/error_codes.rbs

@@ -9,6 +9,8 @@ module CalmLens
     REGIONAL_EVIDENCE_REQUIRED: String
     SIGNED_URL_EXPIRED: String
     SIGNED_URL_INVALID: String
+    SIGNED_URL_ORIGINAL_NOT_GRANTED: String
+    INVALID_REQUEST: String
     INVALID_TYPE: String
     TOO_SMALL: String
     TOO_BIG: String
@@ -17,7 +19,7 @@ module CalmLens
     UNKNOWN_FIELD: String
     UNSUPPORTED_CONTENT_TYPE: String
     INVALID_FILTER: String
-    INVALID_ORDERING_FIELD: String
+    UNSUPPORTED_ORDERING_FIELD: String
     ROUTE_NOT_FOUND: String
     INTERNAL_ERROR: String
     UNAUTHENTICATED: String
@@ -26,24 +28,20 @@ module CalmLens
     SEARCH_UNAVAILABLE: String
     INVALID_TRANSFORM: String
     INVALID_TRANSFORM_OPTIONS: String
-    REMOTE_URL_REDIRECT_LIMIT: String
-    COPYRIGHT_CONTENT_HELD: String
-    DOWNLOAD_PERMISSION_REQUIRED: String
+    REMOTE_URL_TOO_MANY_REDIRECTS: String
     INVALID_CURSOR: String
-    MISSING_TOKEN: String
+    MISSING_API_KEY: String
     INVALID_API_KEY: String
     API_KEY_PROJECT_MISMATCH: String
     API_KEY_NOT_ACCEPTED: String
     PERMISSION_DENIED: String
-    FILE_TOO_LARGE: String
-    MULTIPART_IMAGE_TOO_LARGE: String
-    IMAGE_EXCEEDED_MAX_DIMENSIONS: String
-    IMAGE_INVALID_INPUT: String
-    IMAGE_UNSUPPORTED_FORMAT: String
-    IMAGE_INPUT_LIMIT: String
-    UPLOAD_LIMIT_EXCEEDED: String
-    SPEND_LIMIT_REACHED: String
-    INVALID_UPLOAD_MIME_TYPE: String
+    UPLOAD_TOO_LARGE: String
+    DOCUMENT_TOO_MANY_ITEMS: String
+    INVALID_IMAGE: String
+    IMAGE_TOO_LARGE: String
+    FREE_UPLOADS_EXHAUSTED: String
+    UPLOADS_PAUSED: String
+    UNSUPPORTED_UPLOAD_TYPE: String
     INVALID_UPLOAD_PAYLOAD: String
     USE_UPLOAD_PART: String
     UPLOAD_NOT_OPEN: String
@@ -53,12 +51,14 @@ module CalmLens
     INVALID_IDEMPOTENCY_KEY: String
     IDEMPOTENCY_KEY_REUSED: String
     IDEMPOTENT_REQUEST_IN_PROGRESS: String
+    NO_RENDERED_VERSION: String
     ASSET_NOT_FOUND: String
     PROJECT_NOT_FOUND: String
+    ASSET_CHILD_NOT_DELETABLE: String
     ASSET_REVIEW_CHANGED: String
     ASSET_REVIEW_NOTE_REQUIRED: String
     ASSET_UPDATE_FAILED: String
-    ASSET_SAFETY_HELD: String
+    ASSET_HELD: String
     ASSET_PROCESSING: String
     ASSET_DECISION_NOT_ALLOWED: String
     ASSET_DECISION_UNCHANGED: String
@@ -74,7 +74,8 @@ module CalmLens
     DUPLICATE_FOLDER_NAME: String
     FOLDER_NOT_EMPTY: String
     FOLDER_PARENT_CYCLE: String
-    LENS_VERSION_CONFLICT: String
+    LENS_NOT_FOUND: String
+    LENS_IDENTIFIER_TAKEN: String
     LENS_IDENTIFIER_RESERVED: String
     HASH_LIST_NOT_FOUND: String
     HASH_LIST_ENTRY_NOT_FOUND: String
@@ -94,9 +95,7 @@ module CalmLens
     UPLOAD_PRESET_DISABLED: String
     UPLOAD_PRESET_TOKEN_REQUIRED: String
     REMOTE_URL_NOT_ALLOWED: String
-    WEBSITE_RATE_LIMIT_EXCEEDED: String
-    UPLOAD_PRESET_CONTENT_TYPE_NOT_ALLOWED: String
-    UPLOAD_PRESET_TOO_LARGE: String
+    WEBSITE_RATE_LIMIT_REACHED: String
     UPLOAD_PRESET_DAILY_LIMIT_REACHED: String
     UPLOAD_PRESET_ORIGIN_NOT_ALLOWED: String
     UPLOAD_PRESET_FIELD_NOT_ALLOWED: String
@@ -112,7 +111,6 @@ module CalmLens
     APPEAL_ALREADY_REVIEWED: String
     APPEAL_DECISION_CHANGED: String
     APPEAL_INVALID_ACTION: String
-    APPEAL_SAFETY_HELD: String
     APPEAL_CONTENT_UNAVAILABLE: String
     STATUSES: Hash[String, Integer]
   end

data/sig/qualifiers.rbs

@@ -42,6 +42,8 @@ module CalmLens
     ?"sexual-non-consensual" => qualifier_result,
     ?"sexual-intimate-image-abuse" => qualifier_result,
     ?"sexual-extreme" => qualifier_result,
+    ?"sexual-strangulation" => qualifier_result,
+    ?"sexual-incest" => qualifier_result,
     ?"sexual-minors" => qualifier_result,
     ?"sexual-solicitation" => qualifier_result,
     ?"sexual-paid" => qualifier_result,