@onesi/genesis 0.2.14 → 0.2.15

package/README.md

@@ -3,7 +3,7 @@
 The TypeScript SDK for OneOS. One typed client for every Genesis service, through the Genesis API at `https://os.one.ml/api`.
 
 ```sh
-npm install @onesi/genesis@0.2.14
+npm install @onesi/genesis@0.2.15
 ```
 
 ```ts

package/dist/client.js

@@ -266,7 +266,7 @@ export class GenesisClient {
         const url = this.url(operationId, input);
         const headers = {
             accept: 'application/json',
-            'user-agent': this.opts.userAgent ?? '@onesi/genesis/0.2.14',
+            'user-agent': this.opts.userAgent ?? '@onesi/genesis/0.2.15',
             ...this.opts.headers, ...init.headers,
         };
         if (op.service === 'blinds' && !['GET', 'HEAD', 'OPTIONS'].includes(op.method))

package/dist/dials.d.ts

@@ -16,6 +16,12 @@ export type DialsMessagingBrand = components['schemas']['Dials.MessagingBrand'];
 export type DialsMessagingCampaign = components['schemas']['Dials.MessagingCampaign'];
 export type DialsWorkflowDocument = components['schemas']['Dials.WorkflowDocument'];
 export type DialsWorkflowDeleteReceipt = components['schemas']['Dials.DeleteWorkflowReceipt'];
+export type DialsNumberVoiceHandlerReceipt = components['schemas']['Dials.NumberVoiceHandlerReceipt'];
+export type DialsOneNumber = components['schemas']['Dials.OneNumber'];
+export type DialsOneNumberSuggestions = components['schemas']['Dials.OneNumberSuggestions'];
+export type DialsOneNumberChoice = components['schemas']['Dials.OneNumberChoice'];
+export type DialsMyOneNumber = components['schemas']['Dials.MyOneNumber'];
+export type DialsOneNumberRelease = components['schemas']['Dials.OneNumberRelease'];
 export type DialsRoutingAction = components['schemas']['Dials.RoutingAction'];
 export type DialsRoutingRule = components['schemas']['Dials.RoutingRule'];
 export type DialsRoutingRuleReceipt = components['schemas']['Dials.RoutingRuleReceipt'];
@@ -160,6 +166,39 @@ export declare function dialsModule(client: GenesisClient): {
             next: "workflow_deleted";
         }>;
     };
+    /** A person's own One number (person token): suggestions, the person's choice, their number and its release. */
+    oneNumbers: {
+        /** POST with a JSON body `{areaCode?, text?, lat?, lng?}`; lat and lng travel in the body, never the URL, and a lone one is 400. */
+        suggestions: (body?: OperationInput<"dials_listOneNumberSuggestions">["body"]) => Promise<{
+            state: "suggestions" | "none_found";
+            source: "verified_phone" | "ip_city" | "device" | "search";
+            areaCode?: string | null;
+            city?: string | null;
+            numbers: components["schemas"]["Dials.OneNumberCandidate"][];
+        }>;
+        /** 202 `reserved_intent` while Dials provisioning is off; 409 taken, 429 provisioning_cap, 503 carrier_limit. Not retried automatically. */
+        choose: (body: OperationInput<"dials_chooseOneNumber">["body"]) => Promise<{
+            state: "chosen" | "reserved_intent";
+            number?: components["schemas"]["Dials.OneNumber"];
+        } & {
+            [key: string]: unknown;
+        }>;
+        mine: () => Promise<{
+            number: components["schemas"]["Dials.OneNumber"] | null;
+            plan?: string;
+            idleDays?: number | null;
+            releaseAt?: string | null;
+        } & {
+            [key: string]: unknown;
+        }>;
+        /** Releases the person's own One number at the carrier; it cannot be recovered. */
+        release: () => Promise<{
+            state: "releasing" | "released";
+            number?: components["schemas"]["Dials.OneNumber"] | null;
+        } & {
+            [key: string]: unknown;
+        }>;
+    };
     overview: {
         summary: (scope: DialsScope) => Promise<{
             ok: boolean;
@@ -230,6 +269,16 @@ export declare function dialsModule(client: GenesisClient): {
             auditId: string;
             next: string;
         }>;
+        /** Points an owned SignalWire number's inbound voice webhook at `one_phone` (the One phone line) or `default`; 409 for a non-SignalWire number. */
+        setVoiceHandler: (body: OperationInput<"dials_setNumberVoiceHandler">["body"]) => Promise<{
+            ok: true;
+            phoneNumberId: string;
+            handler: "one_phone" | "default";
+            auditId?: string;
+            next?: string;
+        } & {
+            [key: string]: unknown;
+        }>;
         reconcile: (body: OperationInput<"dials_reconcileNumberInventory">["body"]) => Promise<{
             ok: boolean;
             reconciliations: components["schemas"]["Dials.InventoryReconciliation"][];

package/dist/dials.js

@@ -42,6 +42,16 @@ export function dialsModule(client) {
             /** Deletes the workflow and its routing descriptor; 409 while a held number is assigned to it. */
             delete: (workflowId, body) => client.request('dials_deleteWorkflow', { workflow_id: workflowId, body }),
         },
+        /** A person's own One number (person token): suggestions, the person's choice, their number and its release. */
+        oneNumbers: {
+            /** POST with a JSON body `{areaCode?, text?, lat?, lng?}`; lat and lng travel in the body, never the URL, and a lone one is 400. */
+            suggestions: (body = {}) => client.request('dials_listOneNumberSuggestions', { body }),
+            /** 202 `reserved_intent` while Dials provisioning is off; 409 taken, 429 provisioning_cap, 503 carrier_limit. Not retried automatically. */
+            choose: (body) => client.request('dials_chooseOneNumber', { body }),
+            mine: () => client.request('dials_getMyOneNumber', {}),
+            /** Releases the person's own One number at the carrier; it cannot be recovered. */
+            release: () => client.request('dials_releaseMyOneNumber', {}),
+        },
         overview: {
             summary: (scope) => client.request('dials_getConsoleSummary', scope),
             operatingSurface: (scope) => client.request('dials_getOperatingSurface', scope),
@@ -50,6 +60,8 @@ export function dialsModule(client) {
             reconciliations: (scope) => client.request('dials_listNumberReconciliations', scope),
             drift: (scope) => client.request('dials_listNumberDrift', scope),
             updateCallerName: (body) => client.request('dials_updateNumberCallerName', { body }),
+            /** Points an owned SignalWire number's inbound voice webhook at `one_phone` (the One phone line) or `default`; 409 for a non-SignalWire number. */
+            setVoiceHandler: (body) => client.request('dials_setNumberVoiceHandler', { body }),
             reconcile: (body) => client.request('dials_reconcileNumberInventory', { body }),
             list: (scope) => client.request('dials_listNumbers', scope),
             search: (scope, query = {}) => client.request('dials_searchNumbers', { ...query, ...scope }),

package/dist/fleets.d.ts

@@ -463,6 +463,24 @@ export declare function fleetsModule(client: GenesisClient): {
             updated_at?: number;
         }>;
     };
+    /** The key seat research tasks use to search and read the web through Traces (scopes exactly traces:read; its own slot, never the computer key); KMS-encrypted, never returned. */
+    webConnection: {
+        get: () => Promise<{
+            connected: boolean;
+            updated_at?: number;
+            scopes?: "traces:read"[];
+        }>;
+        set: (api_key: string) => Promise<{
+            connected: boolean;
+            updated_at?: number;
+            scopes?: "traces:read"[];
+        }>;
+        delete: () => Promise<{
+            connected: boolean;
+            updated_at?: number;
+            scopes?: "traces:read"[];
+        }>;
+    };
     usage: {
         /** Task lifecycle and execution-time usage events, paged by task like tasks.list. */
         events: (query?: OperationInput<"fleets_listUsageEvents">) => Promise<{

package/dist/fleets.js

@@ -180,6 +180,11 @@ function validateComputerKey(apiKey) {
         throw invalid('fleets_putComputerConnection', 'Computer key must contain 1–4096 UTF-8 bytes without CR, LF or NUL.');
     }
 }
+function validateWebKey(apiKey) {
+    if (typeof apiKey !== 'string' || !apiKey || byteLength(apiKey) > 4096 || /[\r\n\0]/.test(apiKey)) {
+        throw invalid('fleets_putWebConnection', 'Web key must contain 1–4096 UTF-8 bytes without CR, LF or NUL.');
+    }
+}
 /** Managed Henry instances and tasks scoped to the credential's verified org. */
 export function fleetsModule(client) {
     return {
@@ -378,6 +383,15 @@ export function fleetsModule(client) {
             },
             delete: () => client.request('fleets_deleteComputerConnection', {}),
         },
+        /** The key seat research tasks use to search and read the web through Traces (scopes exactly traces:read; its own slot, never the computer key); KMS-encrypted, never returned. */
+        webConnection: {
+            get: () => client.request('fleets_getWebConnection', {}),
+            set: async (api_key) => {
+                validateWebKey(api_key);
+                return client.request('fleets_putWebConnection', { body: { api_key } });
+            },
+            delete: () => client.request('fleets_deleteWebConnection', {}),
+        },
         usage: {
             /** Task lifecycle and execution-time usage events, paged by task like tasks.list. */
             events: (query = {}) => client.request('fleets_listUsageEvents', query),

package/dist/gateway.d.ts

@@ -112,7 +112,8 @@ export declare function orgsModule(client: GenesisClient): {
  * Your organization's billing: account, contacts, tax IDs, activity, quotas and quota requests, the Minds account,
  * invoices, the raw usage report and the public service catalog. A login session, or an org API key bound to `org`
  * holding genesis.billing.read (reads), genesis.billing.manage (writes) or genesis.usage.read (usage report).
- * Writes need a stable idempotency key; reuse it to replay instead of acting twice. Nothing here pays or charges.
+ * Writes need a stable idempotency key; reuse it to replay instead of acting twice. Only subscription.create can start a
+ * charge, and only in an environment where Genesis Pro is switched on (Sandbox is test money).
  */
 export declare function billingModule(client: GenesisClient): {
     account: {
@@ -131,7 +132,7 @@ export declare function billingModule(client: GenesisClient): {
                 memo?: string | null;
             };
             stripe?: {
-                account_id?: string;
+                account_id?: string | null;
                 customer_id?: string | null;
                 livemode?: boolean;
             };
@@ -153,7 +154,7 @@ export declare function billingModule(client: GenesisClient): {
                 memo?: string | null;
             };
             stripe?: {
-                account_id?: string;
+                account_id?: string | null;
                 customer_id?: string | null;
                 livemode?: boolean;
             };
@@ -216,6 +217,85 @@ export declare function billingModule(client: GenesisClient): {
             deleted: true;
         }>;
     };
+    card: {
+        /** Hosted Stripe Checkout (setup mode, off-session) for the org's billing account: send the customer to `url`; they come back to `return_url`. */
+        setup: (org: string, body: In<"gateway_createBillingCardSetupSession">["body"], idempotencyKey: string) => Promise<{
+            object: "billing_setup_session";
+            url: string;
+            expires_at: string;
+        }>;
+        /** After the return: verifies the completed session, then makes that card the default. */
+        setDefault: (org: string, body: In<"gateway_setBillingDefaultPaymentMethod">["body"], idempotencyKey: string) => Promise<{
+            object: "billing_payment_method";
+            brand?: string | null;
+            last4?: string | null;
+            exp_month?: number | null;
+            exp_year?: number | null;
+            default: true;
+        }>;
+    };
+    subscription: {
+        get: (org: string) => Promise<{
+            object: "genesis_pro_subscription";
+            org_id: string;
+            environment: "sandbox" | "live";
+            plan: "genesis_pro";
+            created?: boolean;
+            enabled?: boolean;
+            stripe?: {
+                account_id?: string | null;
+                mode?: string;
+                livemode?: boolean;
+                test_mode?: boolean;
+            };
+            subscription: {
+                id: string | null;
+                status: string;
+                prices: string[];
+                current_period_start?: string | null;
+                current_period_end?: string | null;
+                latest_invoice?: {
+                    id?: string | null;
+                    status?: string | null;
+                    hosted_invoice_url?: string | null;
+                    amount_due?: number | null;
+                } | null;
+            } | null;
+            entitlement: {
+                [key: string]: unknown;
+            };
+        }>;
+        create: (org: string, body: In<"gateway_createGenesisProSubscription">["body"], idempotencyKey: string) => Promise<{
+            object: "genesis_pro_subscription";
+            org_id: string;
+            environment: "sandbox" | "live";
+            plan: "genesis_pro";
+            created?: boolean;
+            enabled?: boolean;
+            stripe?: {
+                account_id?: string | null;
+                mode?: string;
+                livemode?: boolean;
+                test_mode?: boolean;
+            };
+            subscription: {
+                id: string | null;
+                status: string;
+                prices: string[];
+                current_period_start?: string | null;
+                current_period_end?: string | null;
+                latest_invoice?: {
+                    id?: string | null;
+                    status?: string | null;
+                    hosted_invoice_url?: string | null;
+                    amount_due?: number | null;
+                } | null;
+            } | null;
+            entitlement: {
+                [key: string]: unknown;
+            };
+        }>;
+    };
     quotas: {
         get: (org: string) => Promise<{
             object: "org_quotas";
@@ -362,6 +442,68 @@ export declare function billingModule(client: GenesisClient): {
             }[];
         }[];
     }>;
+    /**
+     * The OneOS Pro pricing catalog (public, no credential): plans, included usage and every meter's rate. Show a rate only
+     * when its `live_metered` is true.
+     */
+    pricing: () => Promise<{
+        object: "billing_pricing";
+        version: string;
+        generated_at: string;
+        source: {
+            service: string;
+            commit: string | null;
+            stripe_mode: "live" | "test" | "off";
+        };
+        currency: "usd";
+        plans: {
+            id: "hobby" | "genesis_pro" | "enterprise";
+            name: string;
+            price_usd_month: string | null;
+            included_usage_usd?: string;
+            card_required?: boolean;
+            stripe_lookup_key?: string;
+            live_priced?: boolean;
+            annual?: {
+                price_usd_year?: string;
+                stripe_lookup_key?: string;
+                live_priced?: boolean;
+            };
+            limits?: {
+                [key: string]: unknown;
+            };
+            contact?: string;
+        }[];
+        rates: {
+            service: string;
+            service_name: string;
+            category?: string | null;
+            meters: string[];
+            label: string;
+            unit?: string | null;
+            granularity?: string | null;
+            rate: {
+                kind?: "fixed" | "list_plus_bps";
+                currency?: "usd";
+                usd_per_unit?: string;
+                per?: string;
+                bps?: number;
+                base?: string;
+            } | null;
+            included?: {
+                [key: string]: unknown;
+            };
+            allowance?: {
+                [key: string]: unknown;
+            };
+            stripe_lookup_key?: string | null;
+            stripe_unit_amount_decimal?: string | null;
+            live_metered: boolean;
+            example?: {
+                [key: string]: unknown;
+            } | null;
+        }[];
+    }>;
 };
 /**
  * Your One credits (the organization's credit balance, ledger, usage, settings, checkout and subscription). A login
@@ -371,7 +513,7 @@ export declare function billingModule(client: GenesisClient): {
  * URL is always on checkout.stripe.com and nothing is charged until you pay on that page.
  */
 export declare function creditsModule(client: GenesisClient): {
-    /** The balance: plan and period, buckets, this month's spend by source, borrow, auto-refill, subscription, pending seat fundings and the Foundry cap mirror. */
+    /** The balance: plan and period, buckets, this month's spend by source, borrow, auto-refill, subscription, pending seat fundings, the Foundry cap mirror and (with One plans on) `one_plan`. */
     get: () => Promise<{
         org: string;
         plan: string;
@@ -404,6 +546,7 @@ export declare function creditsModule(client: GenesisClient): {
             status: string;
             granted_micro_usd: number;
         };
+        one_plan?: import("./index.js").components["schemas"]["Gateway.CreditOnePlan"];
     }>;
     /** The catalog: every price with its credits and amount, the pack rate, the payment methods per mode and the wallet-payment terms. Needs no credits account. */
     catalog: () => Promise<{
@@ -450,11 +593,12 @@ export declare function creditsModule(client: GenesisClient): {
         ref: string | null;
         data: import("./index.js").components["schemas"]["Gateway.CreditUsageRow"][];
     }>;
-    /** Change the borrow ceiling and/or auto-refill (pack 10, 25 or 50). */
+    /** Change the borrow ceiling and/or auto-refill (pack 10, 25 or 50); with One plans on, the daily limit (`daily_limit_credits`, null clears it) and `always_on_one`. */
     updateSettings: (body: In<"gateway_updateCreditSettings">["body"], idempotencyKey: string) => Promise<{
         org: string;
         borrow: import("./index.js").components["schemas"]["Gateway.CreditBorrow"];
         auto_refill: import("./index.js").components["schemas"]["Gateway.CreditAutoRefill"];
+        one_plan?: import("./index.js").components["schemas"]["Gateway.CreditOnePlan"];
     }>;
     /** A Stripe Checkout URL (checkout.stripe.com, test mode) for a plan, seats or a credit pack; `return_to` (https://chat.one.ml/pay or below) is where Checkout sends the person back. */
     checkout: (body: In<"gateway_createCreditCheckout">["body"], idempotencyKey: string) => Promise<{

package/dist/gateway.js

@@ -37,7 +37,8 @@ export function orgsModule(client) {
  * Your organization's billing: account, contacts, tax IDs, activity, quotas and quota requests, the Minds account,
  * invoices, the raw usage report and the public service catalog. A login session, or an org API key bound to `org`
  * holding genesis.billing.read (reads), genesis.billing.manage (writes) or genesis.usage.read (usage report).
- * Writes need a stable idempotency key; reuse it to replay instead of acting twice. Nothing here pays or charges.
+ * Writes need a stable idempotency key; reuse it to replay instead of acting twice. Only subscription.create can start a
+ * charge, and only in an environment where Genesis Pro is switched on (Sandbox is test money).
  */
 export function billingModule(client) {
     const write = (id, input, idempotencyKey) => client.request(id, input, { headers: idempotencyHeaders(id, idempotencyKey) });
@@ -57,6 +58,16 @@ export function billingModule(client) {
             create: (org, body, idempotencyKey) => write('gateway_createBillingTaxId', { org, body }, idempotencyKey),
             delete: (org, taxId, idempotencyKey) => write('gateway_deleteBillingTaxId', { org, tax_id: taxId }, idempotencyKey),
         },
+        card: {
+            /** Hosted Stripe Checkout (setup mode, off-session) for the org's billing account: send the customer to `url`; they come back to `return_url`. */
+            setup: (org, body, idempotencyKey) => write('gateway_createBillingCardSetupSession', { org, body }, idempotencyKey),
+            /** After the return: verifies the completed session, then makes that card the default. */
+            setDefault: (org, body, idempotencyKey) => write('gateway_setBillingDefaultPaymentMethod', { org, body }, idempotencyKey),
+        },
+        subscription: {
+            get: (org) => client.request('gateway_getGenesisProSubscription', { org }),
+            create: (org, body, idempotencyKey) => write('gateway_createGenesisProSubscription', { org, body }, idempotencyKey),
+        },
         quotas: {
             get: (org) => client.request('gateway_getOrgQuotas', { org }),
             requests: {
@@ -78,6 +89,11 @@ export function billingModule(client) {
         service: (org, service) => client.request('gateway_getOrgServiceBilling', { org, service }),
         /** The metered service catalog (public, no credential). */
         catalog: () => client.request('gateway_listBillingServices'),
+        /**
+         * The OneOS Pro pricing catalog (public, no credential): plans, included usage and every meter's rate. Show a rate only
+         * when its `live_metered` is true.
+         */
+        pricing: () => client.request('gateway_getBillingPricing'),
     };
 }
 /**
@@ -90,7 +106,7 @@ export function billingModule(client) {
 export function creditsModule(client) {
     const write = (id, input, idempotencyKey) => client.request(id, input, { headers: idempotencyHeaders(id, idempotencyKey) });
     return {
-        /** The balance: plan and period, buckets, this month's spend by source, borrow, auto-refill, subscription, pending seat fundings and the Foundry cap mirror. */
+        /** The balance: plan and period, buckets, this month's spend by source, borrow, auto-refill, subscription, pending seat fundings, the Foundry cap mirror and (with One plans on) `one_plan`. */
         get: () => client.request('gateway_getCredits'),
         /** The catalog: every price with its credits and amount, the pack rate, the payment methods per mode and the wallet-payment terms. Needs no credits account. */
         catalog: () => client.request('gateway_getCreditCatalog'),
@@ -98,7 +114,7 @@ export function creditsModule(client) {
         entries: (query = {}) => client.request('gateway_listCreditEntries', query),
         /** The usage rows behind a debit; `ref` is the Henry run id or receipt id of a ledger entry. */
         usage: (query = {}) => client.request('gateway_listCreditUsage', query),
-        /** Change the borrow ceiling and/or auto-refill (pack 10, 25 or 50). */
+        /** Change the borrow ceiling and/or auto-refill (pack 10, 25 or 50); with One plans on, the daily limit (`daily_limit_credits`, null clears it) and `always_on_one`. */
         updateSettings: (body, idempotencyKey) => write('gateway_updateCreditSettings', { body }, idempotencyKey),
         /** A Stripe Checkout URL (checkout.stripe.com, test mode) for a plan, seats or a credit pack; `return_to` (https://chat.one.ml/pay or below) is where Checkout sends the person back. */
         checkout: (body, idempotencyKey) => write('gateway_createCreditCheckout', { body }, idempotencyKey),