@signa-so/sdk 0.14.0 → 0.15.0

package/dist/generated/api-types.d.ts

@@ -384,7 +384,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description List all event type codes used in trademark history: the office's verbatim code and label (`raw`, as on a trademark event's `raw`; label null when we hold no verbatim office label for the code, for example USPTO codes today) and the canonical `event_type` Signa maps it to. */
+        /** @description List the office event codes Signa has catalogued and the canonical `event_type` each maps to. The catalogue covers IP Australia (`AU`) and WIPO (`WO`) today; any other office returns an empty list, and its trademark events still carry their own `raw` code and label. `raw` is the office's verbatim code and label, as on a trademark event's `raw` (label null when we hold no verbatim office label for the code; every WIPO label is null because the catalogue's WIPO wording is Signa's). */
         get: operations["listEventTypes"];
         put?: never;
         post?: never;
@@ -2782,7 +2782,8 @@ export interface components {
                 /** @description The computed maintenance schedule in due-date order, ties by rule_id, within a 20-year horizon of `as_of_date`. Empty for dead marks and unsupported records. */
                 items: components["schemas"]["DeadlineRow"][];
             };
-            next_deadline: NonNullable<components["schemas"]["DeadlineRow"]> | null;
+            /** @description The earliest row of `deadlines.items` whose grace period has not passed; on a same-day tie a mandatory row wins over an optional one such as the US §15 affidavit. Null when none. */
+            next_deadline: components["schemas"]["DeadlineRow"] | null;
             opposition_window: components["schemas"]["DerivedOppositionWindow"];
         };
         SourceRecordRef: {
@@ -3607,7 +3608,7 @@ export interface components {
                 [key: string]: string[];
             } | null;
             /**
-             * @description q_any search responses only: the q_any terms (as the caller spelled them) this hit is an exact match for.
+             * @description List searches only (q sent as a list): the terms (as the caller spelled them) this hit is an exact match for.
              * @example [
              *       "limber"
              *     ]
@@ -5283,7 +5284,7 @@ export interface components {
                 /** @description Coded search warnings: per-strategy skip warnings (a REQUESTED strategy produced zero clauses for the query shape — e.g. strategies=[phonetic] on a query too short/high-collision), filter-coverage warnings (an applied filter, e.g. opposition_status or seniority_claims, has partial index coverage), `expanded_fallback` (a grouped request was served one row per record), and `result_window_reached` (the 10,000-row result window, not the data, ends this walk). Omitted when there is nothing to warn about. */
                 warnings?: {
                     /**
-                     * @description Stable warning code for client handling: `<strategy>_skipped` (a requested strategy produced no clauses), `partial_opposition_coverage` / `partial_seniority_coverage` (filter coverage), `partial_results` (the search hit its time limit or lost a shard; the page may be missing matches), `strategies_reduced` (OpenSearch rejected the full query and it was retried with fewer strategies; see `dropped_strategies`), `expanded_fallback` (a grouped request was served one row per record because the grouped view cannot serve a filter, sort or option; see `affected_filters` / `affected_option`), `result_window_reached` (more than 10,000 rows match and this page is the last one the 10,000-row result window lets a relevance or sorted walk reach; a filter-only request sorted by family_updated_at pages past it).
+                     * @description Stable warning code for client handling: `<strategy>_skipped` (a requested strategy produced no clauses), `partial_opposition_coverage` / `partial_seniority_coverage` (filter coverage), `partial_results` (the search hit its time limit or lost a shard; the page may be missing matches), `strategies_reduced` (OpenSearch rejected the full query and it was retried with fewer strategies; see `dropped_strategies`), `expanded_fallback` (a grouped request was served one row per record because the grouped view cannot serve a filter, sort or option; see `affected_filters` / `affected_option`), `result_window_reached` (more than 10,000 rows match and this page is the last one the 10,000-row result window lets a relevance or sorted walk reach; a filter-only request sorted by family_updated_at pages past it), `mixed_script` (a `q` term, or a term of a `q` list, under a deterministic `match` mode mixes Latin with Greek or Cyrillic letters, which that mode compares as written; see `affected_filter`).
                      * @example phonetic_skipped
                      */
                     code: string;
@@ -5369,7 +5370,7 @@ export interface components {
             event_type: string;
             raw: components["schemas"]["OfficeRawValue"] & unknown;
             /**
-             * @description Further office text for the event beyond `raw.label` (for example the details of a recorded change); null when the office gave none.
+             * @description Further text for the event beyond `raw`: office detail such as a recorded change, or, where `raw.label` is withheld because the wording is Signa's, that text (for example EUIPO's `Bulletin 2026/012 Section D.1` or IPOS's `Application filed`). Null when there is nothing beyond `raw`.
              * @example null
              */
             description: string | null;
@@ -6126,7 +6127,7 @@ export interface components {
                 /** @description Coded search warnings: per-strategy skip warnings (a REQUESTED strategy produced zero clauses for the query shape — e.g. strategies=[phonetic] on a query too short/high-collision), filter-coverage warnings (an applied filter, e.g. opposition_status or seniority_claims, has partial index coverage), `expanded_fallback` (a grouped request was served one row per record), and `result_window_reached` (the 10,000-row result window, not the data, ends this walk). Omitted when there is nothing to warn about. */
                 warnings?: {
                     /**
-                     * @description Stable warning code for client handling: `<strategy>_skipped` (a requested strategy produced no clauses), `partial_opposition_coverage` / `partial_seniority_coverage` (filter coverage), `partial_results` (the search hit its time limit or lost a shard; the page may be missing matches), `strategies_reduced` (OpenSearch rejected the full query and it was retried with fewer strategies; see `dropped_strategies`), `expanded_fallback` (a grouped request was served one row per record because the grouped view cannot serve a filter, sort or option; see `affected_filters` / `affected_option`), `result_window_reached` (more than 10,000 rows match and this page is the last one the 10,000-row result window lets a relevance or sorted walk reach; a filter-only request sorted by family_updated_at pages past it).
+                     * @description Stable warning code for client handling: `<strategy>_skipped` (a requested strategy produced no clauses), `partial_opposition_coverage` / `partial_seniority_coverage` (filter coverage), `partial_results` (the search hit its time limit or lost a shard; the page may be missing matches), `strategies_reduced` (OpenSearch rejected the full query and it was retried with fewer strategies; see `dropped_strategies`), `expanded_fallback` (a grouped request was served one row per record because the grouped view cannot serve a filter, sort or option; see `affected_filters` / `affected_option`), `result_window_reached` (more than 10,000 rows match and this page is the last one the 10,000-row result window lets a relevance or sorted walk reach; a filter-only request sorted by family_updated_at pages past it), `mixed_script` (a `q` term, or a term of a `q` list, under a deterministic `match` mode mixes Latin with Greek or Cyrillic letters, which that mode compares as written; see `affected_filter`).
                      * @example phonetic_skipped
                      */
                     code: string;
@@ -6382,7 +6383,7 @@ export interface components {
                 /** @description Coded search warnings: per-strategy skip warnings (a REQUESTED strategy produced zero clauses for the query shape — e.g. strategies=[phonetic] on a query too short/high-collision), filter-coverage warnings (an applied filter, e.g. opposition_status or seniority_claims, has partial index coverage), `expanded_fallback` (a grouped request was served one row per record), and `result_window_reached` (the 10,000-row result window, not the data, ends this walk). Omitted when there is nothing to warn about. */
                 warnings?: {
                     /**
-                     * @description Stable warning code for client handling: `<strategy>_skipped` (a requested strategy produced no clauses), `partial_opposition_coverage` / `partial_seniority_coverage` (filter coverage), `partial_results` (the search hit its time limit or lost a shard; the page may be missing matches), `strategies_reduced` (OpenSearch rejected the full query and it was retried with fewer strategies; see `dropped_strategies`), `expanded_fallback` (a grouped request was served one row per record because the grouped view cannot serve a filter, sort or option; see `affected_filters` / `affected_option`), `result_window_reached` (more than 10,000 rows match and this page is the last one the 10,000-row result window lets a relevance or sorted walk reach; a filter-only request sorted by family_updated_at pages past it).
+                     * @description Stable warning code for client handling: `<strategy>_skipped` (a requested strategy produced no clauses), `partial_opposition_coverage` / `partial_seniority_coverage` (filter coverage), `partial_results` (the search hit its time limit or lost a shard; the page may be missing matches), `strategies_reduced` (OpenSearch rejected the full query and it was retried with fewer strategies; see `dropped_strategies`), `expanded_fallback` (a grouped request was served one row per record because the grouped view cannot serve a filter, sort or option; see `affected_filters` / `affected_option`), `result_window_reached` (more than 10,000 rows match and this page is the last one the 10,000-row result window lets a relevance or sorted walk reach; a filter-only request sorted by family_updated_at pages past it), `mixed_script` (a `q` term, or a term of a `q` list, under a deterministic `match` mode mixes Latin with Greek or Cyrillic letters, which that mode compares as written; see `affected_filter`).
                      * @example phonetic_skipped
                      */
                     code: string;
@@ -6647,7 +6648,7 @@ export interface components {
                 /** @description Coded search warnings: per-strategy skip warnings (a REQUESTED strategy produced zero clauses for the query shape — e.g. strategies=[phonetic] on a query too short/high-collision), filter-coverage warnings (an applied filter, e.g. opposition_status or seniority_claims, has partial index coverage), `expanded_fallback` (a grouped request was served one row per record), and `result_window_reached` (the 10,000-row result window, not the data, ends this walk). Omitted when there is nothing to warn about. */
                 warnings?: {
                     /**
-                     * @description Stable warning code for client handling: `<strategy>_skipped` (a requested strategy produced no clauses), `partial_opposition_coverage` / `partial_seniority_coverage` (filter coverage), `partial_results` (the search hit its time limit or lost a shard; the page may be missing matches), `strategies_reduced` (OpenSearch rejected the full query and it was retried with fewer strategies; see `dropped_strategies`), `expanded_fallback` (a grouped request was served one row per record because the grouped view cannot serve a filter, sort or option; see `affected_filters` / `affected_option`), `result_window_reached` (more than 10,000 rows match and this page is the last one the 10,000-row result window lets a relevance or sorted walk reach; a filter-only request sorted by family_updated_at pages past it).
+                     * @description Stable warning code for client handling: `<strategy>_skipped` (a requested strategy produced no clauses), `partial_opposition_coverage` / `partial_seniority_coverage` (filter coverage), `partial_results` (the search hit its time limit or lost a shard; the page may be missing matches), `strategies_reduced` (OpenSearch rejected the full query and it was retried with fewer strategies; see `dropped_strategies`), `expanded_fallback` (a grouped request was served one row per record because the grouped view cannot serve a filter, sort or option; see `affected_filters` / `affected_option`), `result_window_reached` (more than 10,000 rows match and this page is the last one the 10,000-row result window lets a relevance or sorted walk reach; a filter-only request sorted by family_updated_at pages past it), `mixed_script` (a `q` term, or a term of a `q` list, under a deterministic `match` mode mixes Latin with Greek or Cyrillic letters, which that mode compares as written; see `affected_filter`).
                      * @example phonetic_skipped
                      */
                     code: string;
@@ -6963,7 +6964,7 @@ export interface components {
                 /** @description Coded search warnings: per-strategy skip warnings (a REQUESTED strategy produced zero clauses for the query shape — e.g. strategies=[phonetic] on a query too short/high-collision), filter-coverage warnings (an applied filter, e.g. opposition_status or seniority_claims, has partial index coverage), `expanded_fallback` (a grouped request was served one row per record), and `result_window_reached` (the 10,000-row result window, not the data, ends this walk). Omitted when there is nothing to warn about. */
                 warnings?: {
                     /**
-                     * @description Stable warning code for client handling: `<strategy>_skipped` (a requested strategy produced no clauses), `partial_opposition_coverage` / `partial_seniority_coverage` (filter coverage), `partial_results` (the search hit its time limit or lost a shard; the page may be missing matches), `strategies_reduced` (OpenSearch rejected the full query and it was retried with fewer strategies; see `dropped_strategies`), `expanded_fallback` (a grouped request was served one row per record because the grouped view cannot serve a filter, sort or option; see `affected_filters` / `affected_option`), `result_window_reached` (more than 10,000 rows match and this page is the last one the 10,000-row result window lets a relevance or sorted walk reach; a filter-only request sorted by family_updated_at pages past it).
+                     * @description Stable warning code for client handling: `<strategy>_skipped` (a requested strategy produced no clauses), `partial_opposition_coverage` / `partial_seniority_coverage` (filter coverage), `partial_results` (the search hit its time limit or lost a shard; the page may be missing matches), `strategies_reduced` (OpenSearch rejected the full query and it was retried with fewer strategies; see `dropped_strategies`), `expanded_fallback` (a grouped request was served one row per record because the grouped view cannot serve a filter, sort or option; see `affected_filters` / `affected_option`), `result_window_reached` (more than 10,000 rows match and this page is the last one the 10,000-row result window lets a relevance or sorted walk reach; a filter-only request sorted by family_updated_at pages past it), `mixed_script` (a `q` term, or a term of a `q` list, under a deterministic `match` mode mixes Latin with Greek or Cyrillic letters, which that mode compares as written; see `affected_filter`).
                      * @example phonetic_skipped
                      */
                     code: string;
@@ -11947,7 +11948,6 @@ export interface operations {
                 ranking_profile?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8" | "v9" | "v10" | "v11";
                 match?: "similar" | "exact" | "starts_with" | "ends_with" | "contains";
                 mark_text_not_contains?: string;
-                q_any?: string[] | null;
                 status_primary?: ("pending" | "active" | "inactive" | "unknown" | "mixed")[] | null;
                 status_stage?: ("filed" | "examining" | "pending_publication" | "published" | "opposition_period" | "pending_opposition" | "pending_cancellation" | "pending_issuance" | "registered" | "allowed" | "abandoned" | "withdrawn" | "surrendered" | "refused" | "cancelled" | "invalidated" | "expired" | "unknown" | "mixed")[] | null;
                 status_reason?: ("refused" | "withdrawn" | "abandoned" | "cancelled" | "invalidated" | "expired" | "surrendered" | "revoked" | "other")[] | null;
@@ -12117,22 +12117,13 @@ export interface operations {
             content: {
                 "application/json": {
                     /**
-                     * @description Search query text. Optional for filtered listing. min 2 chars for match=similar; 1 for deterministic match modes.
+                     * @description Search query: one term as a string, or a list of exact terms. A list returns every mark that is an exact match under match=exact rules (case, accents, punctuation and spacing) for ANY of its terms, and each hit carries matched_terms[]. A list takes 1-100 terms of up to 200 characters; terms that differ only in case or accents are sent once under the first spelling, and matched_terms lists the kept spellings a hit matches. A list runs match=exact (the default for a list; any other match, strategies or ranking_profile is a 400). One page costs the same as any search page regardless of term count. A string needs 2 characters for match=similar and 1 for the deterministic match modes. Optional for filtered listing.
                      * @example SIGNA
                      */
-                    query?: string;
+                    query?: string | string[];
                     /** @description Alias for `query` (parity with GET /v1/trademarks). Pass one or the other, not both. */
-                    q?: string;
-                    /**
-                     * @description Several exact terms in one request: returns every mark that is an exact match under match=exact rules (case, accents, punctuation and spacing) for ANY of the terms. 1-200 terms, each 1-200 characters; terms that differ only in case or accents are sent once under the first spelling, and matched_terms lists the kept spellings a hit matches. The whole request body must stay under 8 KB (larger bodies are rejected with 413 before reaching the API). Implies match=exact (any other match is a 400) and replaces query/q. Each hit carries matched_terms[]. One page costs the same as any search page regardless of term count.
-                     * @example [
-                     *       "limber",
-                     *       "bimber",
-                     *       "timbre"
-                     *     ]
-                     */
-                    q_any?: string[];
-                    /** @description Sort field(s), comma-separated, - prefix for desc. Valid: filing_date, registration_date, expiry_date, renewal_due_date, updated_at, family_updated_at, publication_date, termination_date, office_code, jurisdiction_code, mark_text, owner_name. Max 3. family_updated_at is grouped-view only; without q or q_any it pages past 10,000 rows. Default: -filing_date when no query. Note: sort=office_code currently orders by the stored internal office vocabulary (e.g. cipo, ipau), not the public ST.3 codes shown in office_code — ST.3 ordering ships with the office_code_public reindex (flag-gated). */
+                    q?: string | string[];
+                    /** @description Sort field(s), comma-separated, - prefix for desc. Valid: filing_date, registration_date, expiry_date, renewal_due_date, updated_at, family_updated_at, publication_date, termination_date, office_code, jurisdiction_code, mark_text, owner_name. Max 3. family_updated_at is grouped-view only; without q it pages past 10,000 rows. Default: -filing_date when no query. Note: sort=office_code currently orders by the stored internal office vocabulary (e.g. cipo, ipau), not the public ST.3 codes shown in office_code — ST.3 ordering ships with the office_code_public reindex (flag-gated). */
                     sort?: string;
                     /** @description Search strategies (match=similar only). Defaults to exact + fuzzy for text queries. Only the strategies passed run: exact = whole-mark match (plus serial/registration numbers); synonym and phrase matching are part of fuzzy. */
                     strategies?: ("exact" | "phonetic" | "fuzzy" | "prefix")[];
@@ -17579,7 +17570,7 @@ export interface operations {
                 "application/json": {
                     url: string;
                     description?: string;
-                    /** @description Events delivered to this endpoint. Accepted values: alert.created, trademark.status_changed, office_action.issued. trademark.status_changed and office_action.issued are accepted for subscription today but are NOT YET EMITTED — they begin delivering when the API events projector is enabled; both then require the mark to be in one of the organization's portfolios. alert.created follows watch scope. */
+                    /** @description Events delivered to this endpoint. Accepted values: alert.created, trademark.status_changed, office_action.issued. trademark.status_changed and office_action.issued are delivered only for marks in one of the organization's portfolios. alert.created follows watch scope. */
                     enabled_events: string[];
                     /** @description Limit this endpoint to events on marks in this portfolio (ptf_*). Applies to every event type, alert.created included: an alert is delivered only when its matched mark was a member of the portfolio at event time. */
                     portfolio_id?: string | null;
@@ -17708,7 +17699,7 @@ export interface operations {
                 "application/json": {
                     url?: string;
                     description?: string | null;
-                    /** @description Events delivered to this endpoint. Accepted values: alert.created, trademark.status_changed, office_action.issued. trademark.status_changed and office_action.issued are accepted for subscription today but are NOT YET EMITTED — they begin delivering when the API events projector is enabled; both then require the mark to be in one of the organization's portfolios. alert.created follows watch scope. */
+                    /** @description Events delivered to this endpoint. Accepted values: alert.created, trademark.status_changed, office_action.issued. trademark.status_changed and office_action.issued are delivered only for marks in one of the organization's portfolios. alert.created follows watch scope. */
                     enabled_events?: string[];
                     /** @description Limit this endpoint to events on marks in this portfolio (ptf_*), or null to clear. Applies to every event type, alert.created included: an alert is delivered only when its matched mark was a member of the portfolio at event time. */
                     portfolio_id?: string | null;