@l7mp/tivadar-ai-api-sdk 0.2.15 → 0.2.17

package/src/apis/OutboundCallsApi.ts

@@ -0,0 +1,149 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Tivadar AI Backend API
+ * Unified REST API for Tivadar AI Voice Agents platform
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  OutboundCall,
+  OutboundCallRequest,
+  OutboundNumber,
+} from '../models/index';
+import {
+    OutboundCallFromJSON,
+    OutboundCallToJSON,
+    OutboundCallRequestFromJSON,
+    OutboundCallRequestToJSON,
+    OutboundNumberFromJSON,
+    OutboundNumberToJSON,
+} from '../models/index';
+
+export interface OrganizationsOrganizationIdOutboundCallsNumbersGetRequest {
+    organizationId: string;
+}
+
+export interface OrganizationsOrganizationIdOutboundCallsPostRequest {
+    organizationId: string;
+    outboundCallRequest: OutboundCallRequest;
+}
+
+/**
+ * 
+ */
+export class OutboundCallsApi extends runtime.BaseAPI {
+
+    /**
+     * Returns the outbound-ready numbers assigned to the organization, for selecting which one to use as caller-ID (From) when placing a call. Requires the `outbound_calls` feature. 
+     * List the organization\'s outbound-capable caller-ID numbers
+     */
+    async organizationsOrganizationIdOutboundCallsNumbersGetRaw(requestParameters: OrganizationsOrganizationIdOutboundCallsNumbersGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<OutboundNumber>>> {
+        if (requestParameters['organizationId'] == null) {
+            throw new runtime.RequiredError(
+                'organizationId',
+                'Required parameter "organizationId" was null or undefined when calling organizationsOrganizationIdOutboundCallsNumbersGet().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/organizations/{organizationId}/outbound-calls/numbers`;
+        urlPath = urlPath.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(OutboundNumberFromJSON));
+    }
+
+    /**
+     * Returns the outbound-ready numbers assigned to the organization, for selecting which one to use as caller-ID (From) when placing a call. Requires the `outbound_calls` feature. 
+     * List the organization\'s outbound-capable caller-ID numbers
+     */
+    async organizationsOrganizationIdOutboundCallsNumbersGet(requestParameters: OrganizationsOrganizationIdOutboundCallsNumbersGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<OutboundNumber>> {
+        const response = await this.organizationsOrganizationIdOutboundCallsNumbersGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Dials a destination (a phonebook entry or a custom number) using one of the organization\'s voice agents. The caller-ID (From) is the org\'s assigned outbound-capable number. Requires the `outbound_calls` feature (business + enterprise plans). 
+     * Place an outbound call with a voice agent
+     */
+    async organizationsOrganizationIdOutboundCallsPostRaw(requestParameters: OrganizationsOrganizationIdOutboundCallsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OutboundCall>> {
+        if (requestParameters['organizationId'] == null) {
+            throw new runtime.RequiredError(
+                'organizationId',
+                'Required parameter "organizationId" was null or undefined when calling organizationsOrganizationIdOutboundCallsPost().'
+            );
+        }
+
+        if (requestParameters['outboundCallRequest'] == null) {
+            throw new runtime.RequiredError(
+                'outboundCallRequest',
+                'Required parameter "outboundCallRequest" was null or undefined when calling organizationsOrganizationIdOutboundCallsPost().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/organizations/{organizationId}/outbound-calls`;
+        urlPath = urlPath.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: OutboundCallRequestToJSON(requestParameters['outboundCallRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OutboundCallFromJSON(jsonValue));
+    }
+
+    /**
+     * Dials a destination (a phonebook entry or a custom number) using one of the organization\'s voice agents. The caller-ID (From) is the org\'s assigned outbound-capable number. Requires the `outbound_calls` feature (business + enterprise plans). 
+     * Place an outbound call with a voice agent
+     */
+    async organizationsOrganizationIdOutboundCallsPost(requestParameters: OrganizationsOrganizationIdOutboundCallsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OutboundCall> {
+        const response = await this.organizationsOrganizationIdOutboundCallsPostRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -14,6 +14,7 @@ export * from './LLMProvidersApi';
 export * from './MembersApi';
 export * from './NotificationsApi';
 export * from './OrganizationsApi';
+export * from './OutboundCallsApi';
 export * from './PhonebookApi';
 export * from './PlaygroundApi';
 export * from './ProfileApi';

package/src/models/AdminPhoneNumberAssignOutbound.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Tivadar AI Backend API
+ * Unified REST API for Tivadar AI Voice Agents platform
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface AdminPhoneNumberAssignOutbound
+ */
+export interface AdminPhoneNumberAssignOutbound {
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminPhoneNumberAssignOutbound
+     */
+    organization_id: string;
+}
+
+/**
+ * Check if a given object implements the AdminPhoneNumberAssignOutbound interface.
+ */
+export function instanceOfAdminPhoneNumberAssignOutbound(value: object): value is AdminPhoneNumberAssignOutbound {
+    if (!('organization_id' in value) || value['organization_id'] === undefined) return false;
+    return true;
+}
+
+export function AdminPhoneNumberAssignOutboundFromJSON(json: any): AdminPhoneNumberAssignOutbound {
+    return AdminPhoneNumberAssignOutboundFromJSONTyped(json, false);
+}
+
+export function AdminPhoneNumberAssignOutboundFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminPhoneNumberAssignOutbound {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'organization_id': json['organization_id'],
+    };
+}
+
+export function AdminPhoneNumberAssignOutboundToJSON(json: any): AdminPhoneNumberAssignOutbound {
+    return AdminPhoneNumberAssignOutboundToJSONTyped(json, false);
+}
+
+export function AdminPhoneNumberAssignOutboundToJSONTyped(value?: AdminPhoneNumberAssignOutbound | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'organization_id': value['organization_id'],
+    };
+}
+

package/src/models/AdminPhoneNumberDetail.ts

@@ -37,6 +37,36 @@ export interface AdminPhoneNumberDetail {
      * @memberof AdminPhoneNumberDetail
      */
     supports_call_redirect?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AdminPhoneNumberDetail
+     */
+    supports_outbound?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminPhoneNumberDetail
+     */
+    sip_address?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AdminPhoneNumberDetail
+     */
+    outbound_configured?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminPhoneNumberDetail
+     */
+    outbound_organization_id?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminPhoneNumberDetail
+     */
+    outbound_organization_name?: string | null;
     /**
      * 
      * @type {string}
@@ -118,6 +148,11 @@ export function AdminPhoneNumberDetailFromJSONTyped(json: any, ignoreDiscriminat
         'id': json['id'] == null ? undefined : json['id'],
         'number': json['number'] == null ? undefined : json['number'],
         'supports_call_redirect': json['supports_call_redirect'] == null ? undefined : json['supports_call_redirect'],
+        'supports_outbound': json['supports_outbound'] == null ? undefined : json['supports_outbound'],
+        'sip_address': json['sip_address'] == null ? undefined : json['sip_address'],
+        'outbound_configured': json['outbound_configured'] == null ? undefined : json['outbound_configured'],
+        'outbound_organization_id': json['outbound_organization_id'] == null ? undefined : json['outbound_organization_id'],
+        'outbound_organization_name': json['outbound_organization_name'] == null ? undefined : json['outbound_organization_name'],
         'status': json['status'] == null ? undefined : json['status'],
         'created_at': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
         'sip_trunk_id': json['sip_trunk_id'] == null ? undefined : json['sip_trunk_id'],
@@ -143,6 +178,11 @@ export function AdminPhoneNumberDetailToJSONTyped(value?: AdminPhoneNumberDetail
         'id': value['id'],
         'number': value['number'],
         'supports_call_redirect': value['supports_call_redirect'],
+        'supports_outbound': value['supports_outbound'],
+        'sip_address': value['sip_address'],
+        'outbound_configured': value['outbound_configured'],
+        'outbound_organization_id': value['outbound_organization_id'],
+        'outbound_organization_name': value['outbound_organization_name'],
         'status': value['status'],
         'created_at': value['created_at'] == null ? value['created_at'] : value['created_at'].toISOString(),
         'sip_trunk_id': value['sip_trunk_id'],

package/src/models/AdminPhoneNumberUpdate.ts

@@ -31,6 +31,24 @@ export interface AdminPhoneNumberUpdate {
      * @memberof AdminPhoneNumberUpdate
      */
     supports_call_redirect?: boolean;
+    /**
+     * Update the outbound SIP address (outbound numbers only).
+     * @type {string}
+     * @memberof AdminPhoneNumberUpdate
+     */
+    sip_address?: string;
+    /**
+     * Update the outbound SIP auth username (re-encrypted).
+     * @type {string}
+     * @memberof AdminPhoneNumberUpdate
+     */
+    auth_username?: string;
+    /**
+     * Update the outbound SIP auth password (re-encrypted).
+     * @type {string}
+     * @memberof AdminPhoneNumberUpdate
+     */
+    auth_password?: string;
 }
 
 /**
@@ -52,6 +70,9 @@ export function AdminPhoneNumberUpdateFromJSONTyped(json: any, ignoreDiscriminat
         
         'number': json['number'] == null ? undefined : json['number'],
         'supports_call_redirect': json['supports_call_redirect'] == null ? undefined : json['supports_call_redirect'],
+        'sip_address': json['sip_address'] == null ? undefined : json['sip_address'],
+        'auth_username': json['auth_username'] == null ? undefined : json['auth_username'],
+        'auth_password': json['auth_password'] == null ? undefined : json['auth_password'],
     };
 }
 
@@ -68,6 +89,9 @@ export function AdminPhoneNumberUpdateToJSONTyped(value?: AdminPhoneNumberUpdate
         
         'number': value['number'],
         'supports_call_redirect': value['supports_call_redirect'],
+        'sip_address': value['sip_address'],
+        'auth_username': value['auth_username'],
+        'auth_password': value['auth_password'],
     };
 }
 

package/src/models/OutboundCall.ts

@@ -0,0 +1,113 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Tivadar AI Backend API
+ * Unified REST API for Tivadar AI Voice Agents platform
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface OutboundCall
+ */
+export interface OutboundCall {
+    /**
+     * 
+     * @type {string}
+     * @memberof OutboundCall
+     */
+    call_id?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof OutboundCall
+     */
+    room_name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OutboundCall
+     */
+    destination?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OutboundCall
+     */
+    from_number?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OutboundCall
+     */
+    participant_identity?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OutboundCall
+     */
+    sip_participant_id?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof OutboundCall
+     */
+    dispatched?: boolean;
+}
+
+/**
+ * Check if a given object implements the OutboundCall interface.
+ */
+export function instanceOfOutboundCall(value: object): value is OutboundCall {
+    return true;
+}
+
+export function OutboundCallFromJSON(json: any): OutboundCall {
+    return OutboundCallFromJSONTyped(json, false);
+}
+
+export function OutboundCallFromJSONTyped(json: any, ignoreDiscriminator: boolean): OutboundCall {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'call_id': json['call_id'] == null ? undefined : json['call_id'],
+        'room_name': json['room_name'] == null ? undefined : json['room_name'],
+        'destination': json['destination'] == null ? undefined : json['destination'],
+        'from_number': json['from_number'] == null ? undefined : json['from_number'],
+        'participant_identity': json['participant_identity'] == null ? undefined : json['participant_identity'],
+        'sip_participant_id': json['sip_participant_id'] == null ? undefined : json['sip_participant_id'],
+        'dispatched': json['dispatched'] == null ? undefined : json['dispatched'],
+    };
+}
+
+export function OutboundCallToJSON(json: any): OutboundCall {
+    return OutboundCallToJSONTyped(json, false);
+}
+
+export function OutboundCallToJSONTyped(value?: OutboundCall | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'call_id': value['call_id'],
+        'room_name': value['room_name'],
+        'destination': value['destination'],
+        'from_number': value['from_number'],
+        'participant_identity': value['participant_identity'],
+        'sip_participant_id': value['sip_participant_id'],
+        'dispatched': value['dispatched'],
+    };
+}
+

package/src/models/OutboundCallRequest.ts

@@ -0,0 +1,90 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Tivadar AI Backend API
+ * Unified REST API for Tivadar AI Voice Agents platform
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface OutboundCallRequest
+ */
+export interface OutboundCallRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof OutboundCallRequest
+     */
+    voice_agent_id: string;
+    /**
+     * Destination from a phonebook entry. Provide this OR destination_number.
+     * @type {string}
+     * @memberof OutboundCallRequest
+     */
+    phonebook_entry_id?: string;
+    /**
+     * Custom destination phone number. Provide this OR phonebook_entry_id.
+     * @type {string}
+     * @memberof OutboundCallRequest
+     */
+    destination_number?: string;
+    /**
+     * Which of the org's outbound-capable numbers to use as caller-ID (From). Omit to auto-select.
+     * @type {number}
+     * @memberof OutboundCallRequest
+     */
+    from_phone_number_id?: number;
+}
+
+/**
+ * Check if a given object implements the OutboundCallRequest interface.
+ */
+export function instanceOfOutboundCallRequest(value: object): value is OutboundCallRequest {
+    if (!('voice_agent_id' in value) || value['voice_agent_id'] === undefined) return false;
+    return true;
+}
+
+export function OutboundCallRequestFromJSON(json: any): OutboundCallRequest {
+    return OutboundCallRequestFromJSONTyped(json, false);
+}
+
+export function OutboundCallRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): OutboundCallRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'voice_agent_id': json['voice_agent_id'],
+        'phonebook_entry_id': json['phonebook_entry_id'] == null ? undefined : json['phonebook_entry_id'],
+        'destination_number': json['destination_number'] == null ? undefined : json['destination_number'],
+        'from_phone_number_id': json['from_phone_number_id'] == null ? undefined : json['from_phone_number_id'],
+    };
+}
+
+export function OutboundCallRequestToJSON(json: any): OutboundCallRequest {
+    return OutboundCallRequestToJSONTyped(json, false);
+}
+
+export function OutboundCallRequestToJSONTyped(value?: OutboundCallRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'voice_agent_id': value['voice_agent_id'],
+        'phonebook_entry_id': value['phonebook_entry_id'],
+        'destination_number': value['destination_number'],
+        'from_phone_number_id': value['from_phone_number_id'],
+    };
+}
+

package/src/models/OutboundNumber.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Tivadar AI Backend API
+ * Unified REST API for Tivadar AI Voice Agents platform
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * An outbound-capable number assigned to the organization, usable as caller-ID.
+ * @export
+ * @interface OutboundNumber
+ */
+export interface OutboundNumber {
+    /**
+     * 
+     * @type {number}
+     * @memberof OutboundNumber
+     */
+    id?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof OutboundNumber
+     */
+    number?: string;
+}
+
+/**
+ * Check if a given object implements the OutboundNumber interface.
+ */
+export function instanceOfOutboundNumber(value: object): value is OutboundNumber {
+    return true;
+}
+
+export function OutboundNumberFromJSON(json: any): OutboundNumber {
+    return OutboundNumberFromJSONTyped(json, false);
+}
+
+export function OutboundNumberFromJSONTyped(json: any, ignoreDiscriminator: boolean): OutboundNumber {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'number': json['number'] == null ? undefined : json['number'],
+    };
+}
+
+export function OutboundNumberToJSON(json: any): OutboundNumber {
+    return OutboundNumberToJSONTyped(json, false);
+}
+
+export function OutboundNumberToJSONTyped(value?: OutboundNumber | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'number': value['number'],
+    };
+}
+

package/src/models/PhoneNumber.ts

@@ -43,6 +43,24 @@ export interface PhoneNumber {
      * @memberof PhoneNumber
      */
     supports_call_redirect?: boolean;
+    /**
+     * Whether this number can place outbound calls (has an outbound trunk).
+     * @type {boolean}
+     * @memberof PhoneNumber
+     */
+    supports_outbound?: boolean;
+    /**
+     * Outbound SIP provider host/address (outbound numbers only).
+     * @type {string}
+     * @memberof PhoneNumber
+     */
+    sip_address?: string | null;
+    /**
+     * Whether the outbound trunk + credentials are configured. Secrets are never returned.
+     * @type {boolean}
+     * @memberof PhoneNumber
+     */
+    outbound_configured?: boolean;
     /**
      * 
      * @type {Date}
@@ -72,6 +90,9 @@ export function PhoneNumberFromJSONTyped(json: any, ignoreDiscriminator: boolean
         'number': json['number'] == null ? undefined : json['number'],
         'sip_trunk_id': json['sip_trunk_id'] == null ? undefined : json['sip_trunk_id'],
         'supports_call_redirect': json['supports_call_redirect'] == null ? undefined : json['supports_call_redirect'],
+        'supports_outbound': json['supports_outbound'] == null ? undefined : json['supports_outbound'],
+        'sip_address': json['sip_address'] == null ? undefined : json['sip_address'],
+        'outbound_configured': json['outbound_configured'] == null ? undefined : json['outbound_configured'],
         'created_at': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
     };
 }
@@ -91,6 +112,9 @@ export function PhoneNumberToJSONTyped(value?: PhoneNumber | null, ignoreDiscrim
         'number': value['number'],
         'sip_trunk_id': value['sip_trunk_id'],
         'supports_call_redirect': value['supports_call_redirect'],
+        'supports_outbound': value['supports_outbound'],
+        'sip_address': value['sip_address'],
+        'outbound_configured': value['outbound_configured'],
         'created_at': value['created_at'] == null ? value['created_at'] : value['created_at'].toISOString(),
     };
 }