telnyx 6.74.2 → 7.1.0

package/src/resources/terms-of-service/terms-of-service.ts

@@ -1,17 +1,162 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as AgreementsAPI from './agreements';
+import {
+  AgreementListParams,
+  Agreements,
+  TosAgreement,
+  TosAgreementWrapped,
+  TosAgreementsDefaultFlatPagination,
+  TosProductType,
+} from './agreements';
+import * as BrandedCallingAPI from './branded-calling';
+import { BrandedCalling } from './branded-calling';
 import * as NumberReputationAPI from './number-reputation';
 import { NumberReputation } from './number-reputation';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * Accept and review the Branded Calling and Phone Number Reputation terms of service.
+ */
 export class TermsOfService extends APIResource {
   numberReputation: NumberReputationAPI.NumberReputation = new NumberReputationAPI.NumberReputation(
     this._client,
   );
+  agreements: AgreementsAPI.Agreements = new AgreementsAPI.Agreements(this._client);
+  brandedCalling: BrandedCallingAPI.BrandedCalling = new BrandedCallingAPI.BrandedCalling(this._client);
+
+  /**
+   * Returns the available Terms of Service agreements (product, current version,
+   * terms URL, effective date). Omit `product_type` to return all products; pass it
+   * to scope to one.
+   */
+  retrieveInfo(
+    query: TermsOfServiceRetrieveInfoParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TermsOfServiceRetrieveInfoResponse> {
+    return this._client.get('/terms_of_service/info', { query, ...options });
+  }
+
+  /**
+   * Returns whether the authenticated user has agreed to the current Terms of
+   * Service for the product given by `product_type`. Used during onboarding to
+   * decide whether to prompt the user with the ToS dialog before continuing.
+   *
+   * `agreement_required: true` means the user has not yet agreed (or has agreed to
+   * an outdated version) and must agree before using that product's endpoints.
+   */
+  retrieveStatus(
+    query: TermsOfServiceRetrieveStatusParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TermsOfServiceRetrieveStatusResponse> {
+    return this._client.get('/terms_of_service/status', { query, ...options });
+  }
+}
+
+export interface TermsOfServiceRetrieveInfoResponse {
+  agreements?: Array<TermsOfServiceRetrieveInfoResponse.Agreement>;
+}
+
+export namespace TermsOfServiceRetrieveInfoResponse {
+  export interface Agreement {
+    current_version?: string;
+
+    description?: string;
+
+    effective_date?: string;
+
+    /**
+     * Telnyx product the Terms of Service apply to.
+     */
+    product_type?: AgreementsAPI.TosProductType;
+
+    terms_url?: string;
+  }
+}
+
+export interface TermsOfServiceRetrieveStatusResponse {
+  /**
+   * Whether the calling user has agreed to a product's current Terms of Service. The
+   * `user_id` is intentionally omitted on this public surface.
+   */
+  data: TermsOfServiceRetrieveStatusResponse.Data;
+}
+
+export namespace TermsOfServiceRetrieveStatusResponse {
+  /**
+   * Whether the calling user has agreed to a product's current Terms of Service. The
+   * `user_id` is intentionally omitted on this public surface.
+   */
+  export interface Data {
+    /**
+     * `true` when the user must agree to the latest version before using the product.
+     * Equivalent to `!has_agreed`.
+     */
+    agreement_required: boolean;
+
+    /**
+     * Latest published version of the ToS for this product.
+     */
+    current_terms_version: string;
+
+    /**
+     * `true` if the user has agreed to the latest version.
+     */
+    has_agreed: boolean;
+
+    /**
+     * Telnyx product the Terms of Service apply to.
+     */
+    product_type: AgreementsAPI.TosProductType;
+
+    agreed_at?: string | null;
+
+    /**
+     * Version the user previously agreed to (may be older than
+     * `current_terms_version`). `null` if the user has never agreed.
+     */
+    agreed_version?: string | null;
+  }
+}
+
+export interface TermsOfServiceRetrieveInfoParams {
+  /**
+   * Optional product filter. Omit to return info for all products.
+   */
+  product_type?: AgreementsAPI.TosProductType;
+}
+
+export interface TermsOfServiceRetrieveStatusParams {
+  /**
+   * Which product's ToS to check. Defaults to `branded_calling`.
+   */
+  product_type?: AgreementsAPI.TosProductType;
 }
 
 TermsOfService.NumberReputation = NumberReputation;
+TermsOfService.Agreements = Agreements;
+TermsOfService.BrandedCalling = BrandedCalling;
 
 export declare namespace TermsOfService {
+  export {
+    type TermsOfServiceRetrieveInfoResponse as TermsOfServiceRetrieveInfoResponse,
+    type TermsOfServiceRetrieveStatusResponse as TermsOfServiceRetrieveStatusResponse,
+    type TermsOfServiceRetrieveInfoParams as TermsOfServiceRetrieveInfoParams,
+    type TermsOfServiceRetrieveStatusParams as TermsOfServiceRetrieveStatusParams,
+  };
+
   export { NumberReputation as NumberReputation };
+
+  export {
+    Agreements as Agreements,
+    type TosAgreement as TosAgreement,
+    type TosAgreementWrapped as TosAgreementWrapped,
+    type TosProductType as TosProductType,
+    type TosAgreementsDefaultFlatPagination as TosAgreementsDefaultFlatPagination,
+    type AgreementListParams as AgreementListParams,
+  };
+
+  export { BrandedCalling as BrandedCalling };
 }

package/src/resources/texml/accounts/accounts.ts

@@ -4,50 +4,46 @@ import { APIResource } from '../../../core/resource';
 import * as QueuesAPI from './queues';
 import {
   QueueCreateParams,
-  QueueCreateResponse,
   QueueDeleteParams,
   QueueListParams,
-  QueueListResponse,
-  QueueListResponsesDefaultPaginationForQueues,
+  QueueResource,
+  QueueResourcesDefaultPaginationForQueues,
   QueueRetrieveParams,
-  QueueRetrieveResponse,
   QueueUpdateParams,
-  QueueUpdateResponse,
   Queues,
 } from './queues';
 import * as CallsAPI from './calls/calls';
 import {
   CallCallsParams,
   CallCallsResponse,
+  CallResource,
   CallRetrieveCallsParams,
   CallRetrieveCallsResponse,
   CallRetrieveParams,
-  CallRetrieveResponse,
   CallSiprecJsonParams,
   CallSiprecJsonResponse,
   CallStreamsJsonParams,
   CallStreamsJsonResponse,
   CallUpdateParams,
-  CallUpdateResponse,
   Calls,
   UpdateCall,
 } from './calls/calls';
+import * as RecordingsJsonAPI from './calls/recordings-json';
 import * as ConferencesAPI from './conferences/conferences';
 import {
+  ConferenceResource,
   ConferenceRetrieveConferencesParams,
   ConferenceRetrieveConferencesResponse,
   ConferenceRetrieveParams,
   ConferenceRetrieveRecordingsJsonParams,
-  ConferenceRetrieveRecordingsJsonResponse,
   ConferenceRetrieveRecordingsParams,
   ConferenceRetrieveRecordingsResponse,
-  ConferenceRetrieveResponse,
   ConferenceUpdateParams,
-  ConferenceUpdateResponse,
   Conferences,
 } from './conferences/conferences';
 import * as RecordingsAPI from './recordings/recordings';
 import { Recordings } from './recordings/recordings';
+import * as JsonAPI from './transcriptions/json';
 import * as TranscriptionsAPI from './transcriptions/transcriptions';
 import { Transcriptions } from './transcriptions/transcriptions';
 import { APIPromise } from '../../../core/api-promise';
@@ -69,7 +65,7 @@ export class Accounts extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const texmlGetCallRecordingsResponseBody =
    *   await client.texml.accounts.retrieveRecordingsJson(
    *     'account_sid',
    *   );
@@ -79,7 +75,7 @@ export class Accounts extends APIResource {
     accountSid: string,
     query: AccountRetrieveRecordingsJsonParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<AccountRetrieveRecordingsJsonResponse> {
+  ): APIPromise<RecordingsJsonAPI.TexmlGetCallRecordingsResponseBody> {
     return this._client.get(path`/texml/Accounts/${accountSid}/Recordings.json`, { query, ...options });
   }
 
@@ -108,7 +104,7 @@ export interface TexmlGetCallRecordingResponseBody {
 
   call_sid?: string;
 
-  channels?: 1 | 2;
+  channels?: RecordingsJsonAPI.TwimlRecordingChannels;
 
   conference_sid?: string | null;
 
@@ -133,14 +129,7 @@ export interface TexmlGetCallRecordingResponseBody {
   /**
    * Defines how the recording was created.
    */
-  source?:
-    | 'StartCallRecordingAPI'
-    | 'StartConferenceRecordingAPI'
-    | 'OutboundAPI'
-    | 'DialVerb'
-    | 'Conference'
-    | 'RecordVerb'
-    | 'Trunking';
+  source?: RecordingsJsonAPI.RecordingSource;
 
   start_time?: string;
 
@@ -164,50 +153,6 @@ export interface TexmlRecordingSubresourcesUris {
   transcriptions?: string | null;
 }
 
-export interface AccountRetrieveRecordingsJsonResponse {
-  /**
-   * The number of the last element on the page, zero-indexed.
-   */
-  end?: number;
-
-  /**
-   * Relative uri to the first page of the query results
-   */
-  first_page_uri?: string;
-
-  /**
-   * Relative uri to the next page of the query results
-   */
-  next_page_uri?: string;
-
-  /**
-   * Current page number, zero-indexed.
-   */
-  page?: number;
-
-  /**
-   * The number of items on the page
-   */
-  page_size?: number;
-
-  /**
-   * Relative uri to the previous page of the query results
-   */
-  previous_page_uri?: string;
-
-  recordings?: Array<TexmlGetCallRecordingResponseBody>;
-
-  /**
-   * The number of the first element on the page, zero-indexed.
-   */
-  start?: number;
-
-  /**
-   * The URI of the current page.
-   */
-  uri?: string;
-}
-
 export interface AccountRetrieveTranscriptionsJsonResponse {
   /**
    * The number of the last element on the page, zero-indexed
@@ -244,7 +189,7 @@ export interface AccountRetrieveTranscriptionsJsonResponse {
    */
   start?: number;
 
-  transcriptions?: Array<AccountRetrieveTranscriptionsJsonResponse.Transcription>;
+  transcriptions?: Array<JsonAPI.TexmlRecordingTranscription>;
 
   /**
    * The URI of the current page.
@@ -252,54 +197,6 @@ export interface AccountRetrieveTranscriptionsJsonResponse {
   uri?: string;
 }
 
-export namespace AccountRetrieveTranscriptionsJsonResponse {
-  export interface Transcription {
-    account_sid?: string;
-
-    /**
-     * The version of the API that was used to make the request.
-     */
-    api_version?: string;
-
-    call_sid?: string;
-
-    date_created?: string;
-
-    date_updated?: string;
-
-    /**
-     * The duration of this recording, given in seconds.
-     */
-    duration?: string | null;
-
-    /**
-     * Identifier of a resource.
-     */
-    recording_sid?: string;
-
-    /**
-     * Identifier of a resource.
-     */
-    sid?: string;
-
-    /**
-     * The status of the recording transcriptions. The transcription text will be
-     * available only when the status is completed.
-     */
-    status?: 'in-progress' | 'completed';
-
-    /**
-     * The recording's transcribed text
-     */
-    transcription_text?: string;
-
-    /**
-     * The relative URI for the recording transcription resource.
-     */
-    uri?: string;
-  }
-}
-
 export interface AccountRetrieveRecordingsJsonParams {
   /**
    * Filters recording by the creation date. Expected format is ISO8601 date or
@@ -342,7 +239,6 @@ export declare namespace Accounts {
   export {
     type TexmlGetCallRecordingResponseBody as TexmlGetCallRecordingResponseBody,
     type TexmlRecordingSubresourcesUris as TexmlRecordingSubresourcesUris,
-    type AccountRetrieveRecordingsJsonResponse as AccountRetrieveRecordingsJsonResponse,
     type AccountRetrieveTranscriptionsJsonResponse as AccountRetrieveTranscriptionsJsonResponse,
     type AccountRetrieveRecordingsJsonParams as AccountRetrieveRecordingsJsonParams,
     type AccountRetrieveTranscriptionsJsonParams as AccountRetrieveTranscriptionsJsonParams,
@@ -350,9 +246,8 @@ export declare namespace Accounts {
 
   export {
     Calls as Calls,
+    type CallResource as CallResource,
     type UpdateCall as UpdateCall,
-    type CallRetrieveResponse as CallRetrieveResponse,
-    type CallUpdateResponse as CallUpdateResponse,
     type CallCallsResponse as CallCallsResponse,
     type CallRetrieveCallsResponse as CallRetrieveCallsResponse,
     type CallSiprecJsonResponse as CallSiprecJsonResponse,
@@ -367,11 +262,9 @@ export declare namespace Accounts {
 
   export {
     Conferences as Conferences,
-    type ConferenceRetrieveResponse as ConferenceRetrieveResponse,
-    type ConferenceUpdateResponse as ConferenceUpdateResponse,
+    type ConferenceResource as ConferenceResource,
     type ConferenceRetrieveConferencesResponse as ConferenceRetrieveConferencesResponse,
     type ConferenceRetrieveRecordingsResponse as ConferenceRetrieveRecordingsResponse,
-    type ConferenceRetrieveRecordingsJsonResponse as ConferenceRetrieveRecordingsJsonResponse,
     type ConferenceRetrieveParams as ConferenceRetrieveParams,
     type ConferenceUpdateParams as ConferenceUpdateParams,
     type ConferenceRetrieveConferencesParams as ConferenceRetrieveConferencesParams,
@@ -385,11 +278,8 @@ export declare namespace Accounts {
 
   export {
     Queues as Queues,
-    type QueueCreateResponse as QueueCreateResponse,
-    type QueueRetrieveResponse as QueueRetrieveResponse,
-    type QueueUpdateResponse as QueueUpdateResponse,
-    type QueueListResponse as QueueListResponse,
-    type QueueListResponsesDefaultPaginationForQueues as QueueListResponsesDefaultPaginationForQueues,
+    type QueueResource as QueueResource,
+    type QueueResourcesDefaultPaginationForQueues as QueueResourcesDefaultPaginationForQueues,
     type QueueCreateParams as QueueCreateParams,
     type QueueRetrieveParams as QueueRetrieveParams,
     type QueueUpdateParams as QueueUpdateParams,