@signa-so/sdk 0.8.0 → 0.9.0

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

@@ -88,6 +88,49 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/offices/votes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description List the authenticated organization's office-coverage votes, alphabetical by office code. The set is bounded by the votable vocabulary, so the list is always a single page: `limit` and `cursor` are accepted for list-client compatibility but do not affect the response, which always returns every vote with `has_more: false`. */
+        get: operations["listOfficeVotes"];
+        put?: never;
+        /**
+         * @description Vote for trademark offices your organization wants on Signa. One vote per office per organization — re-votes are no-ops, so the call is safely retryable. Returns the stored votes for every requested code (newly cast or pre-existing).
+         *
+         *     This operation requires an `Idempotency-Key` header (see parameter description for 24h replay and 409-conflict semantics).
+         */
+        post: operations["castOfficeVotes"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/offices/votes/{code}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * @description Retract your organization's vote for an office. Accepts the same code vocabulary as casting; votes for offices that have since gone live can still be retracted.
+         *
+         *     This operation requires an `Idempotency-Key` header (see parameter description for 24h replay and 409-conflict semantics).
+         */
+        delete: operations["retractOfficeVote"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/classifications": {
         parameters: {
             query?: never;
@@ -1419,7 +1462,7 @@ export interface paths {
         };
         /** @description Read the org auto-top-up config. Internal (dashboard BFF); requires organization:manage. */
         get: operations["getAutoTopUpConfig"];
-        /** @description Update the org auto-top-up config. Internal (dashboard BFF); requires organization:manage. */
+        /** @description Update the org auto-top-up config. Internal (dashboard BFF); requires organization:manage. Any update whose MERGED result would be enabled is refused with 501 — auto-top-up charges saved cards off-session, which Stripe Managed Payments does not support. Disabling (enabled:false) and editing a stored, disabled config remain allowed. */
         put: operations["setAutoTopUpConfig"];
         post?: never;
         delete?: never;
@@ -2415,27 +2458,33 @@ export interface components {
             data: components["schemas"]["ScreeningHitV3"][];
             request_id?: string;
         };
-        Classification: {
-            /** @example 9 */
-            class_number: number;
+        OfficeVoteResource: {
             /** @enum {string} */
-            object: "classification";
-            /** @example Electrical and scientific apparatus */
-            title: string;
-            description: string | null;
-            category: string | null;
+            object: "office_vote";
+            /**
+             * @description Canonical WIPO ST.3 office code (uppercase), e.g. BR, MX, BX.
+             * @example BR
+             */
+            office_code: string;
+            /**
+             * @description Current coverage of the voted office: `live` (now on Signa — your ask landed), `roadmap` (modeled, connector not shipping yet), `not_covered` (not modeled yet).
+             * @enum {string}
+             */
+            office_status: "live" | "roadmap" | "not_covered";
+            /** @description When this org first voted for the office. */
+            created_at: string;
         };
-        ClassificationListResponse: {
+        OfficeVoteList: {
             /** @enum {string} */
             object: "list";
-            data: components["schemas"]["Classification"][];
+            data: components["schemas"]["OfficeVoteResource"][];
             has_more: boolean;
             pagination: {
                 cursor: string | null;
                 total_count?: number;
                 total_count_approximate?: boolean;
             };
-            request_id?: string;
+            request_id: string;
         };
         Error: {
             error: {
@@ -2471,6 +2520,36 @@ export interface components {
             /** @example req_abc123 */
             request_id: string;
         };
+        OfficeVoteDeleted: {
+            /** @enum {string} */
+            object: "office_vote";
+            office_code: string;
+            /** @enum {boolean} */
+            deleted: true;
+            request_id: string;
+        };
+        Classification: {
+            /** @example 9 */
+            class_number: number;
+            /** @enum {string} */
+            object: "classification";
+            /** @example Electrical and scientific apparatus */
+            title: string;
+            description: string | null;
+            category: string | null;
+        };
+        ClassificationListResponse: {
+            /** @enum {string} */
+            object: "list";
+            data: components["schemas"]["Classification"][];
+            has_more: boolean;
+            pagination: {
+                cursor: string | null;
+                total_count?: number;
+                total_count_approximate?: boolean;
+            };
+            request_id?: string;
+        };
         GoodsServicesTerm: {
             /** @example Computer software for data processing */
             term: string;
@@ -6432,6 +6511,8 @@ export interface components {
             saved_payment_method: string | null;
             month_to_date_spend_usd: number;
             last_failure_reason: string | null;
+            /** @description True while auto-top-up charging is suspended fleet-wide (all Signa payments run through Stripe Managed Payments, which cannot make automatic off-session charges). While true, any update whose merged result would be enabled is refused with 501. */
+            suspended: boolean;
             request_id: string;
         };
         NotificationCategory: {
@@ -6669,6 +6750,153 @@ export interface operations {
             };
         };
     };
+    listOfficeVotes: {
+        parameters: {
+            query?: {
+                limit?: number;
+                cursor?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description List of office votes */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OfficeVoteList"];
+                };
+            };
+            /** @description Invalid query parameter */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Missing or invalid API key */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    castOfficeVotes: {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description Unique key for safe retries. Responses to a given key are cached for 24h; retrying the same key with the same body replays the original response (with an Idempotent-Replayed: true header); the same key with a different body returns 409 conflict. */
+                "Idempotency-Key": string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    /**
+                     * @description Office codes to vote for (1–50). ST.3 / ISO country codes, any case (surrounding whitespace is trimmed); legacy internal codes and reserved aliases like UK are canonicalized. Offices Signa already covers are rejected — vote for what you want added. Codes your organization already voted for are no-ops, never double counts.
+                     * @example [
+                     *       "BR",
+                     *       "MX"
+                     *     ]
+                     */
+                    office_codes: string[];
+                };
+            };
+        };
+        responses: {
+            /** @description Stored votes for the requested codes */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OfficeVoteList"];
+                };
+            };
+            /** @description Unknown, already-covered, or register-less office code (unknown_office_code / office_already_live / no_trademark_register) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Missing or invalid API key */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    retractOfficeVote: {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description Unique key for safe retries. Responses to a given key are cached for 24h; retrying the same key with the same body replays the original response (with an Idempotent-Replayed: true header); the same key with a different body returns 409 conflict. */
+                "Idempotency-Key": string;
+            };
+            path: {
+                code: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Vote deleted */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OfficeVoteDeleted"];
+                };
+            };
+            /** @description Unknown office code */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Missing or invalid API key */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description No vote for this office */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     listClassifications: {
         parameters: {
             query?: {
@@ -12097,6 +12325,11 @@ export interface operations {
                      * @description Redirect on cancel.
                      */
                     cancel_url?: string;
+                    /**
+                     * Format: email
+                     * @description Billing email for the Stripe customer (receipts, invoices, failed-payment mail). The dashboard BFF passes the signed-in user's address. Write-once seed: ignored when the organization already has a billing email (later changes flow from the Stripe customer via the customer.updated webhook).
+                     */
+                    billing_email?: string;
                 };
             };
         };
@@ -12146,6 +12379,24 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
+            /** @description Organization already has an active subscription */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Billing is not configured on this deployment (Stripe key absent) */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
         };
     };
     createBillingPortal: {
@@ -12166,6 +12417,11 @@ export interface operations {
                      * @description Return URL after the portal.
                      */
                     return_url?: string;
+                    /**
+                     * Format: email
+                     * @description Billing email for the Stripe customer (receipts, invoices, failed-payment mail). The dashboard BFF passes the signed-in user's address. Write-once seed: ignored when the organization already has a billing email (later changes flow from the Stripe customer via the customer.updated webhook).
+                     */
+                    billing_email?: string;
                 };
             };
         };
@@ -12179,6 +12435,15 @@ export interface operations {
                     "application/json": components["schemas"]["StripeBillingPortalResponse"];
                 };
             };
+            /** @description Validation error */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
             /** @description Missing or invalid API key */
             401: {
                 headers: {
@@ -12206,6 +12471,15 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
+            /** @description Billing is not configured on this deployment (Stripe key absent) */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
         };
     };
     createCreditPackCheckout: {
@@ -12236,6 +12510,11 @@ export interface operations {
                      * @description Redirect on cancel.
                      */
                     cancel_url?: string;
+                    /**
+                     * Format: email
+                     * @description Billing email for the Stripe customer (receipts, invoices, failed-payment mail). The dashboard BFF passes the signed-in user's address. Write-once seed: ignored when the organization already has a billing email (later changes flow from the Stripe customer via the customer.updated webhook).
+                     */
+                    billing_email?: string;
                 };
             };
         };
@@ -12285,6 +12564,15 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
+            /** @description Billing is not configured on this deployment (Stripe key absent) */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
         };
     };
     getAutoTopUpConfig: {
@@ -12372,7 +12660,7 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /** @description Missing scope, or plan cannot enable auto-top-up */
+            /** @description Missing organization:manage scope */
             403: {
                 headers: {
                     [name: string]: unknown;
@@ -12381,6 +12669,15 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
+            /** @description Auto-top-up cannot be enabled: all Signa payments run through Stripe Managed Payments, which does not support automatic off-session charges. */
+            501: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
         };
     };
     getNotificationPreferences: {