telnyx 2.0.1-beta.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/VERSION CHANGED
@@ -1 +1 @@
1
- 2.0.1-beta.0
1
+ 2.0.1
@@ -690,7 +690,11 @@ export interface paths {
690
690
  path?: never;
691
691
  cookie?: never;
692
692
  };
693
- get?: never;
693
+ /**
694
+ * Get a specific assistant version
695
+ * @description Retrieves a specific version of an assistant by assistant_id and version_id
696
+ */
697
+ get: operations['get_assistant_version_public_assistants__assistant_id__versions__version_id__get'];
694
698
  put?: never;
695
699
  /**
696
700
  * Update a specific assistant version
@@ -718,7 +722,7 @@ export interface paths {
718
722
  put?: never;
719
723
  /**
720
724
  * Promote an assistant version to main
721
- * @description Promotes a specific version to be the main/current version of the assistant
725
+ * @description Promotes a specific version to be the main/current version of the assistant. This will delete any existing canary deploy configuration and send all live production traffic to this version.
722
726
  */
723
727
  post: operations['promote_assistant_version_public_assistants__assistant_id__versions__version_id__promote_post'];
724
728
  delete?: never;
@@ -3097,6 +3101,60 @@ export interface paths {
3097
3101
  patch?: never;
3098
3102
  trace?: never;
3099
3103
  };
3104
+ '/charges_summary': {
3105
+ parameters: {
3106
+ query?: never;
3107
+ header?: never;
3108
+ path?: never;
3109
+ cookie?: never;
3110
+ };
3111
+ /**
3112
+ * Get monthly charges summary
3113
+ * @description Retrieve a summary of monthly charges for a specified date range. The date range cannot exceed 31 days to prevent large queries that could cause timeouts.
3114
+ */
3115
+ get: {
3116
+ parameters: {
3117
+ query: {
3118
+ /** @description Start date for the charges summary in ISO date format (YYYY-MM-DD) */
3119
+ start_date: string;
3120
+ /** @description End date for the charges summary in ISO date format (YYYY-MM-DD). The interval between start_date and end_date cannot exceed 31 days. */
3121
+ end_date: string;
3122
+ };
3123
+ header?: never;
3124
+ path?: never;
3125
+ cookie?: never;
3126
+ };
3127
+ requestBody?: never;
3128
+ responses: {
3129
+ /** @description Monthly charges summary */
3130
+ 200: {
3131
+ headers: {
3132
+ [name: string]: unknown;
3133
+ };
3134
+ content: {
3135
+ 'application/json': components['schemas']['MonthlyChargesSummaryResponse'];
3136
+ };
3137
+ };
3138
+ /** @description Bad request - invalid date range or parameters */
3139
+ 400: {
3140
+ headers: {
3141
+ [name: string]: unknown;
3142
+ };
3143
+ content: {
3144
+ 'application/json': components['schemas']['Errors'];
3145
+ };
3146
+ };
3147
+ default: components['responses']['GenericErrorResponse'];
3148
+ };
3149
+ };
3150
+ put?: never;
3151
+ post?: never;
3152
+ delete?: never;
3153
+ options?: never;
3154
+ head?: never;
3155
+ patch?: never;
3156
+ trace?: never;
3157
+ };
3100
3158
  '/comments': {
3101
3159
  parameters: {
3102
3160
  query?: never;
@@ -5549,6 +5607,60 @@ export interface paths {
5549
5607
  patch?: never;
5550
5608
  trace?: never;
5551
5609
  };
5610
+ '/messages/rcs/deeplinks/{agent_id}': {
5611
+ parameters: {
5612
+ query?: never;
5613
+ header?: never;
5614
+ path?: never;
5615
+ cookie?: never;
5616
+ };
5617
+ /**
5618
+ * Generate RCS deeplink
5619
+ * @description Generate a deeplink URL that can be used to start an RCS conversation with a specific agent.
5620
+ */
5621
+ get: {
5622
+ parameters: {
5623
+ query?: {
5624
+ /**
5625
+ * @description Phone number in E164 format (URL encoded)
5626
+ * @example %2B18445550001
5627
+ */
5628
+ phone_number?: string;
5629
+ /**
5630
+ * @description Pre-filled message body (URL encoded)
5631
+ * @example hello%20world
5632
+ */
5633
+ body?: string;
5634
+ };
5635
+ header?: never;
5636
+ path: {
5637
+ /** @description RCS agent ID */
5638
+ agent_id: string;
5639
+ };
5640
+ cookie?: never;
5641
+ };
5642
+ requestBody?: never;
5643
+ responses: {
5644
+ /** @description Successful response with deeplink URL */
5645
+ 200: {
5646
+ headers: {
5647
+ [name: string]: unknown;
5648
+ };
5649
+ content: {
5650
+ 'application/json': components['schemas']['RCSDeeplinkResponse'];
5651
+ };
5652
+ };
5653
+ default: components['responses']['GenericErrorResponse'];
5654
+ };
5655
+ };
5656
+ put?: never;
5657
+ post?: never;
5658
+ delete?: never;
5659
+ options?: never;
5660
+ head?: never;
5661
+ patch?: never;
5662
+ trace?: never;
5663
+ };
5552
5664
  '/messages/schedule': {
5553
5665
  parameters: {
5554
5666
  query?: never;
@@ -12101,6 +12213,24 @@ export interface components {
12101
12213
  record_type?: 'address_suggestion';
12102
12214
  };
12103
12215
  };
12216
+ AdjustmentLine: {
12217
+ /**
12218
+ * @description Adjustment amount as decimal string
12219
+ * @example -10.00
12220
+ */
12221
+ amount: string;
12222
+ /**
12223
+ * @description Description of the adjustment
12224
+ * @example Credit for service outage
12225
+ */
12226
+ description: string;
12227
+ /**
12228
+ * Format: date
12229
+ * @description Date when the adjustment occurred
12230
+ * @example 2025-05-15
12231
+ */
12232
+ event_date: string;
12233
+ };
12104
12234
  /** AdvancedOrderRequest */
12105
12235
  AdvancedOrderRequest: {
12106
12236
  /**
@@ -14876,6 +15006,23 @@ export interface components {
14876
15006
  /** @example ok */
14877
15007
  result?: string;
14878
15008
  };
15009
+ /**
15010
+ * Call Control Command Result With Conversation ID
15011
+ * @example {
15012
+ * "result": "ok",
15013
+ * "conversation_id": "d7e9c1d4-8b2a-4b8f-b3a7-9a671c9e9b0a"
15014
+ * }
15015
+ */
15016
+ CallControlCommandResultWithConversationId: {
15017
+ /** @example ok */
15018
+ result?: string;
15019
+ /**
15020
+ * Format: uuid
15021
+ * @description The ID of the conversation created by the command.
15022
+ * @example d7e9c1d4-8b2a-4b8f-b3a7-9a671c9e9b0a
15023
+ */
15024
+ conversation_id?: string;
15025
+ };
14879
15026
  /**
14880
15027
  * Call Control Command Result With Recording ID
14881
15028
  * @example {
@@ -17064,6 +17211,7 @@ export interface components {
17064
17211
  * "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
17065
17212
  * "link_to": "ilditnZK_eVysupV21KzmzN_sM29ygfauQojpm4BgFtfX5hXAcjotg==",
17066
17213
  * "bridge_intent": true,
17214
+ * "bridge_on_answer": true,
17067
17215
  * "media_encryption": "SRTP",
17068
17216
  * "sip_auth_username": "username",
17069
17217
  * "sip_auth_password": "password",
@@ -17334,6 +17482,12 @@ export interface components {
17334
17482
  * @example true
17335
17483
  */
17336
17484
  bridge_intent: boolean;
17485
+ /**
17486
+ * @description Whether to automatically bridge answered call to the call specified in link_to. When bridge_on_answer is true, link_to becomes required.
17487
+ * @default false
17488
+ * @example true
17489
+ */
17490
+ bridge_on_answer: boolean;
17337
17491
  /**
17338
17492
  * @description Defines whether media should be encrypted on the call.
17339
17493
  * @default disabled
@@ -19103,6 +19257,25 @@ export interface components {
19103
19257
  */
19104
19258
  readonly updated_at?: string;
19105
19259
  };
19260
+ ComparativeLine: {
19261
+ /**
19262
+ * @description discriminator enum property added by openapi-typescript
19263
+ * @enum {string}
19264
+ */
19265
+ type: 'ComparativeLine';
19266
+ /**
19267
+ * @description Service name
19268
+ * @example Local DIDs
19269
+ */
19270
+ name: string;
19271
+ /**
19272
+ * @description Service alias
19273
+ * @example local
19274
+ */
19275
+ alias: string;
19276
+ new_this_month: components['schemas']['MonthDetail'];
19277
+ existing_this_month: components['schemas']['MonthDetail'];
19278
+ };
19106
19279
  /**
19107
19280
  * OTAUpdate
19108
19281
  * @description This object represents an Over the Air (OTA) update request. It allows tracking the current status of a operation that apply settings in a particular SIM card. <br/><br/>
@@ -31314,6 +31487,26 @@ export interface components {
31314
31487
  * @default false
31315
31488
  */
31316
31489
  Monochrome: boolean;
31490
+ MonthDetail: {
31491
+ /**
31492
+ * @description Number of items
31493
+ * @example 10
31494
+ */
31495
+ quantity: number;
31496
+ /**
31497
+ * @description Monthly recurring charge amount as decimal string
31498
+ * @example 25.50
31499
+ */
31500
+ mrc: string;
31501
+ /**
31502
+ * @description One-time charge amount as decimal string
31503
+ * @example 5.00
31504
+ */
31505
+ otc?: string | null;
31506
+ };
31507
+ MonthlyChargesSummaryResponse: {
31508
+ data: components['schemas']['SummaryAndTotal'];
31509
+ };
31317
31510
  Network: components['schemas']['Record'] & {
31318
31511
  /**
31319
31512
  * @description Identifies the type of the resource.
@@ -36753,6 +36946,15 @@ export interface components {
36753
36946
  /** @description Event description. Maximum 500 characters. */
36754
36947
  description?: string;
36755
36948
  };
36949
+ RCSDeeplinkResponse: {
36950
+ data: {
36951
+ /**
36952
+ * @description The generated deeplink URL
36953
+ * @example sms:+18445550001?service_id=my_agent_id%40rbm.goog&body=hello%20world
36954
+ */
36955
+ url: string;
36956
+ };
36957
+ };
36756
36958
  /** @description Opens the user's default dialer app with the agent-specified phone number filled in. */
36757
36959
  RCSDialAction: {
36758
36960
  /**
@@ -39395,6 +39597,33 @@ export interface components {
39395
39597
  */
39396
39598
  record_type: 'SimCardUsageDetailRecord';
39397
39599
  };
39600
+ SimpleLine: {
39601
+ /**
39602
+ * @description discriminator enum property added by openapi-typescript
39603
+ * @enum {string}
39604
+ */
39605
+ type: 'SimpleLine';
39606
+ /**
39607
+ * @description Service name
39608
+ * @example Port Out
39609
+ */
39610
+ name: string;
39611
+ /**
39612
+ * @description Service alias
39613
+ * @example port_out
39614
+ */
39615
+ alias: string;
39616
+ /**
39617
+ * @description Number of items
39618
+ * @example 100
39619
+ */
39620
+ quantity: number;
39621
+ /**
39622
+ * @description Total amount as decimal string
39623
+ * @example 15.75
39624
+ */
39625
+ amount: string;
39626
+ };
39398
39627
  /** SIMCard */
39399
39628
  SimpleSIMCard: {
39400
39629
  /**
@@ -40413,6 +40642,7 @@ export interface components {
40413
40642
  */
40414
40643
  StreamBidirectionalTargetLegs: 'both' | 'self' | 'opposite';
40415
40644
  /**
40645
+ * Stream Codec
40416
40646
  * @description Specifies the codec to be used for the streamed audio. When set to 'default' or when transcoding is not possible, the codec from the call will be used. Currently, transcoding is only supported between PCMU and PCMA codecs.
40417
40647
  * @default default
40418
40648
  * @example PCMA
@@ -40707,6 +40937,47 @@ export interface components {
40707
40937
  */
40708
40938
  readonly updated_at?: string;
40709
40939
  };
40940
+ Summary: {
40941
+ /** @description List of charge summary lines */
40942
+ lines: components['schemas']['SummaryLine'][];
40943
+ /** @description List of billing adjustments */
40944
+ adjustments: components['schemas']['AdjustmentLine'][];
40945
+ };
40946
+ SummaryAndTotal: {
40947
+ /**
40948
+ * @description User identifier
40949
+ * @example 0db0b4aa-a83d-4d4f-ad9b-3ba7c1ac2ce8
40950
+ */
40951
+ user_id: string;
40952
+ /**
40953
+ * Format: date
40954
+ * @description Start date of the summary period
40955
+ * @example 2025-05-01
40956
+ */
40957
+ start_date: string;
40958
+ /**
40959
+ * Format: date
40960
+ * @description End date of the summary period
40961
+ * @example 2025-06-01
40962
+ */
40963
+ end_date: string;
40964
+ /**
40965
+ * Format: email
40966
+ * @description User email address
40967
+ * @example user@example.com
40968
+ */
40969
+ user_email: string;
40970
+ /**
40971
+ * @description Currency code
40972
+ * @example USD
40973
+ */
40974
+ currency: string;
40975
+ summary: components['schemas']['Summary'];
40976
+ total: components['schemas']['TotalSummary'];
40977
+ };
40978
+ SummaryLine:
40979
+ | components['schemas']['ComparativeLine']
40980
+ | components['schemas']['SimpleLine'];
40710
40981
  /** SummaryRequest */
40711
40982
  SummaryRequest: {
40712
40983
  /** @description The name of the bucket that contains the file to be summarized. */
@@ -42989,6 +43260,43 @@ export interface components {
42989
43260
  * @example +E.164
42990
43261
  */
42991
43262
  ToNumber: string;
43263
+ TotalSummary: {
43264
+ /**
43265
+ * @description Total new monthly recurring charges as decimal string
43266
+ * @example 50.00
43267
+ */
43268
+ new_mrc: string;
43269
+ /**
43270
+ * @description Total new one-time charges as decimal string
43271
+ * @example 25.00
43272
+ */
43273
+ new_otc: string;
43274
+ /**
43275
+ * @description Total existing monthly recurring charges as decimal string
43276
+ * @example 100.00
43277
+ */
43278
+ existing_mrc: string;
43279
+ /**
43280
+ * @description Other charges as decimal string
43281
+ * @example 10.00
43282
+ */
43283
+ other: string;
43284
+ /**
43285
+ * @description Total credits as decimal string
43286
+ * @example -5.00
43287
+ */
43288
+ credits: string;
43289
+ /**
43290
+ * @description Ledger adjustments as decimal string
43291
+ * @example 0.00
43292
+ */
43293
+ ledger_adjustments: string;
43294
+ /**
43295
+ * @description Grand total of all charges as decimal string
43296
+ * @example 180.00
43297
+ */
43298
+ grand_total: string;
43299
+ };
42992
43300
  /**
42993
43301
  * @description Specifies the type of traffic allowed in this profile.
42994
43302
  * @default conversational
@@ -43373,6 +43681,11 @@ export interface components {
43373
43681
  * @example 600
43374
43682
  */
43375
43683
  time_limit_secs: number;
43684
+ /**
43685
+ * @description Specifies behavior after the bridge ends (i.e. the opposite leg either hangs up or is transferred). If supplied with the value `self`, the current leg will be parked after unbridge. If not set, the default behavior is to hang up the leg.
43686
+ * @example self
43687
+ */
43688
+ park_after_unbridge?: string;
43376
43689
  /**
43377
43690
  * @description Enables Answering Machine Detection. When a call is answered, Telnyx runs real-time detection to determine if it was picked up by a human or a machine and sends an `call.machine.detection.ended` webhook with the analysis result. If 'greeting_end' or 'detect_words' is used and a 'machine' is detected, you will receive another 'call.machine.greeting.ended' webhook when the answering machine greeting ends with a beep or silence. If `detect_beep` is used, you will only receive 'call.machine.greeting.ended' if a beep is detected.
43378
43691
  * @default disabled
@@ -48605,6 +48918,17 @@ export interface components {
48605
48918
  };
48606
48919
  };
48607
48920
  };
48921
+ /** @description Successful response upon making a call control command that includes conversation_id. */
48922
+ CallControlCommandResponseWithConversationId: {
48923
+ headers: {
48924
+ [name: string]: unknown;
48925
+ };
48926
+ content: {
48927
+ 'application/json': {
48928
+ data?: components['schemas']['CallControlCommandResultWithConversationId'];
48929
+ };
48930
+ };
48931
+ };
48608
48932
  /** @description Successful response upon making a call control command that includes recording_id. */
48609
48933
  CallControlCommandResponseWithRecordingId: {
48610
48934
  headers: {
@@ -54607,6 +54931,40 @@ export interface operations {
54607
54931
  };
54608
54932
  };
54609
54933
  };
54934
+ get_assistant_version_public_assistants__assistant_id__versions__version_id__get: {
54935
+ parameters: {
54936
+ query?: {
54937
+ include_mcp_servers?: boolean;
54938
+ };
54939
+ header?: never;
54940
+ path: {
54941
+ assistant_id: string;
54942
+ version_id: string;
54943
+ };
54944
+ cookie?: never;
54945
+ };
54946
+ requestBody?: never;
54947
+ responses: {
54948
+ /** @description Returns the specific assistant version configuration */
54949
+ 200: {
54950
+ headers: {
54951
+ [name: string]: unknown;
54952
+ };
54953
+ content: {
54954
+ 'application/json': components['schemas']['Assistant'];
54955
+ };
54956
+ };
54957
+ /** @description Validation Error */
54958
+ 422: {
54959
+ headers: {
54960
+ [name: string]: unknown;
54961
+ };
54962
+ content: {
54963
+ 'application/json': components['schemas']['HTTPValidationError'];
54964
+ };
54965
+ };
54966
+ };
54967
+ };
54610
54968
  update_assistant_version_public_assistants__assistant_id__versions__version_id__post: {
54611
54969
  parameters: {
54612
54970
  query?: never;
@@ -57712,7 +58070,7 @@ export interface operations {
57712
58070
  };
57713
58071
  };
57714
58072
  responses: {
57715
- 200: components['responses']['CallControlCommandResponse'];
58073
+ 200: components['responses']['CallControlCommandResponseWithConversationId'];
57716
58074
  default: components['responses']['GenericErrorResponse'];
57717
58075
  };
57718
58076
  };
@@ -57922,7 +58280,7 @@ export interface operations {
57922
58280
  };
57923
58281
  };
57924
58282
  responses: {
57925
- 200: components['responses']['CallControlCommandResponse'];
58283
+ 200: components['responses']['CallControlCommandResponseWithConversationId'];
57926
58284
  default: components['responses']['GenericErrorResponse'];
57927
58285
  };
57928
58286
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "telnyx",
3
- "version": "2.0.1-beta.0",
3
+ "version": "2.0.1",
4
4
  "description": "Telnyx API Node SDK",
5
5
  "keywords": [
6
6
  "telnyx",