@stream-io/video-client 1.36.0 → 1.37.0

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.
@@ -1205,7 +1205,7 @@ export interface CallMissedEvent {
1205
1205
  user: UserResponse;
1206
1206
  }
1207
1207
  /**
1208
- *
1208
+ * This event is sent when a moderation blur action is applied to a user's video stream
1209
1209
  * @export
1210
1210
  * @interface CallModerationBlurEvent
1211
1211
  */
@@ -1223,7 +1223,7 @@ export interface CallModerationBlurEvent {
1223
1223
  */
1224
1224
  created_at: string;
1225
1225
  /**
1226
- *
1226
+ * Custom data associated with the moderation action
1227
1227
  * @type {{ [key: string]: any; }}
1228
1228
  * @memberof CallModerationBlurEvent
1229
1229
  */
@@ -1231,20 +1231,20 @@ export interface CallModerationBlurEvent {
1231
1231
  [key: string]: any;
1232
1232
  };
1233
1233
  /**
1234
- *
1234
+ * The type of event: "call.moderation_blur" in this case
1235
1235
  * @type {string}
1236
1236
  * @memberof CallModerationBlurEvent
1237
1237
  */
1238
1238
  type: string;
1239
1239
  /**
1240
- *
1240
+ * The user ID whose video stream is being blurred
1241
1241
  * @type {string}
1242
1242
  * @memberof CallModerationBlurEvent
1243
1243
  */
1244
1244
  user_id: string;
1245
1245
  }
1246
1246
  /**
1247
- *
1247
+ * This event is sent when a moderation warning is issued to a user
1248
1248
  * @export
1249
1249
  * @interface CallModerationWarningEvent
1250
1250
  */
@@ -1262,7 +1262,7 @@ export interface CallModerationWarningEvent {
1262
1262
  */
1263
1263
  created_at: string;
1264
1264
  /**
1265
- *
1265
+ * Custom data associated with the moderation action
1266
1266
  * @type {{ [key: string]: any; }}
1267
1267
  * @memberof CallModerationWarningEvent
1268
1268
  */
@@ -1270,19 +1270,19 @@ export interface CallModerationWarningEvent {
1270
1270
  [key: string]: any;
1271
1271
  };
1272
1272
  /**
1273
- *
1273
+ * The warning message
1274
1274
  * @type {string}
1275
1275
  * @memberof CallModerationWarningEvent
1276
1276
  */
1277
1277
  message: string;
1278
1278
  /**
1279
- *
1279
+ * The type of event: "call.moderation_warning" in this case
1280
1280
  * @type {string}
1281
1281
  * @memberof CallModerationWarningEvent
1282
1282
  */
1283
1283
  type: string;
1284
1284
  /**
1285
- *
1285
+ * The user ID who is receiving the warning
1286
1286
  * @type {string}
1287
1287
  * @memberof CallModerationWarningEvent
1288
1288
  */
@@ -2233,6 +2233,12 @@ export interface CallSessionResponse {
2233
2233
  * @memberof CallSessionResponse
2234
2234
  */
2235
2235
  anonymous_participant_count: number;
2236
+ /**
2237
+ *
2238
+ * @type {string}
2239
+ * @memberof CallSessionResponse
2240
+ */
2241
+ created_at: string;
2236
2242
  /**
2237
2243
  *
2238
2244
  * @type {string}
@@ -2550,6 +2556,55 @@ export interface CallStateResponseFields {
2550
2556
  */
2551
2557
  own_capabilities: Array<OwnCapability>;
2552
2558
  }
2559
+ /**
2560
+ *
2561
+ * @export
2562
+ * @interface CallStatsLocation
2563
+ */
2564
+ export interface CallStatsLocation {
2565
+ /**
2566
+ *
2567
+ * @type {number}
2568
+ * @memberof CallStatsLocation
2569
+ */
2570
+ accuracy_radius_meters?: number;
2571
+ /**
2572
+ *
2573
+ * @type {string}
2574
+ * @memberof CallStatsLocation
2575
+ */
2576
+ city?: string;
2577
+ /**
2578
+ *
2579
+ * @type {string}
2580
+ * @memberof CallStatsLocation
2581
+ */
2582
+ continent?: string;
2583
+ /**
2584
+ *
2585
+ * @type {string}
2586
+ * @memberof CallStatsLocation
2587
+ */
2588
+ country?: string;
2589
+ /**
2590
+ *
2591
+ * @type {number}
2592
+ * @memberof CallStatsLocation
2593
+ */
2594
+ latitude?: number;
2595
+ /**
2596
+ *
2597
+ * @type {number}
2598
+ * @memberof CallStatsLocation
2599
+ */
2600
+ longitude?: number;
2601
+ /**
2602
+ *
2603
+ * @type {string}
2604
+ * @memberof CallStatsLocation
2605
+ */
2606
+ subdivision?: string;
2607
+ }
2553
2608
  /**
2554
2609
  *
2555
2610
  * @export
@@ -2605,6 +2660,18 @@ export interface CallStatsParticipantCounts {
2605
2660
  * @memberof CallStatsParticipantCounts
2606
2661
  */
2607
2662
  participants: number;
2663
+ /**
2664
+ *
2665
+ * @type {number}
2666
+ * @memberof CallStatsParticipantCounts
2667
+ */
2668
+ peak_concurrent_sessions: number;
2669
+ /**
2670
+ *
2671
+ * @type {number}
2672
+ * @memberof CallStatsParticipantCounts
2673
+ */
2674
+ peak_concurrent_users: number;
2608
2675
  /**
2609
2676
  *
2610
2677
  * @type {number}
@@ -2624,12 +2691,42 @@ export interface CallStatsParticipantCounts {
2624
2691
  * @interface CallStatsParticipantSession
2625
2692
  */
2626
2693
  export interface CallStatsParticipantSession {
2694
+ /**
2695
+ *
2696
+ * @type {string}
2697
+ * @memberof CallStatsParticipantSession
2698
+ */
2699
+ browser?: string;
2700
+ /**
2701
+ *
2702
+ * @type {string}
2703
+ * @memberof CallStatsParticipantSession
2704
+ */
2705
+ browser_version?: string;
2627
2706
  /**
2628
2707
  *
2629
2708
  * @type {number}
2630
2709
  * @memberof CallStatsParticipantSession
2631
2710
  */
2632
2711
  cq_score?: number;
2712
+ /**
2713
+ *
2714
+ * @type {string}
2715
+ * @memberof CallStatsParticipantSession
2716
+ */
2717
+ current_ip?: string;
2718
+ /**
2719
+ *
2720
+ * @type {string}
2721
+ * @memberof CallStatsParticipantSession
2722
+ */
2723
+ current_sfu?: string;
2724
+ /**
2725
+ *
2726
+ * @type {number}
2727
+ * @memberof CallStatsParticipantSession
2728
+ */
2729
+ distance_to_sfu_kilometers?: number;
2633
2730
  /**
2634
2731
  *
2635
2732
  * @type {string}
@@ -2642,6 +2739,18 @@ export interface CallStatsParticipantSession {
2642
2739
  * @memberof CallStatsParticipantSession
2643
2740
  */
2644
2741
  is_live: boolean;
2742
+ /**
2743
+ *
2744
+ * @type {CallStatsLocation}
2745
+ * @memberof CallStatsParticipantSession
2746
+ */
2747
+ location?: CallStatsLocation;
2748
+ /**
2749
+ *
2750
+ * @type {string}
2751
+ * @memberof CallStatsParticipantSession
2752
+ */
2753
+ os?: string;
2645
2754
  /**
2646
2755
  *
2647
2756
  * @type {PublishedTrackFlags}
@@ -2654,6 +2763,18 @@ export interface CallStatsParticipantSession {
2654
2763
  * @memberof CallStatsParticipantSession
2655
2764
  */
2656
2765
  publisher_type?: string;
2766
+ /**
2767
+ *
2768
+ * @type {string}
2769
+ * @memberof CallStatsParticipantSession
2770
+ */
2771
+ sdk?: string;
2772
+ /**
2773
+ *
2774
+ * @type {string}
2775
+ * @memberof CallStatsParticipantSession
2776
+ */
2777
+ sdk_version?: string;
2657
2778
  /**
2658
2779
  *
2659
2780
  * @type {string}
@@ -2672,6 +2793,12 @@ export interface CallStatsParticipantSession {
2672
2793
  * @memberof CallStatsParticipantSession
2673
2794
  */
2674
2795
  user_session_id: string;
2796
+ /**
2797
+ *
2798
+ * @type {string}
2799
+ * @memberof CallStatsParticipantSession
2800
+ */
2801
+ webrtc_version?: string;
2675
2802
  }
2676
2803
  /**
2677
2804
  * This event is sent when the insights report is ready
@@ -3937,7 +4064,6 @@ export declare const FrameRecordingSettingsRequestQualityEnum: {
3937
4064
  readonly _720P: "720p";
3938
4065
  readonly _1080P: "1080p";
3939
4066
  readonly _1440P: "1440p";
3940
- readonly _2160P: "2160p";
3941
4067
  };
3942
4068
  export type FrameRecordingSettingsRequestQualityEnum = (typeof FrameRecordingSettingsRequestQualityEnum)[keyof typeof FrameRecordingSettingsRequestQualityEnum];
3943
4069
  /**
@@ -5176,6 +5302,31 @@ export interface MessageStatsResponse {
5176
5302
  */
5177
5303
  count_over_time?: Array<CountByMinuteResponse>;
5178
5304
  }
5305
+ /**
5306
+ *
5307
+ * @export
5308
+ * @interface MetricDescriptor
5309
+ */
5310
+ export interface MetricDescriptor {
5311
+ /**
5312
+ *
5313
+ * @type {string}
5314
+ * @memberof MetricDescriptor
5315
+ */
5316
+ description?: string;
5317
+ /**
5318
+ *
5319
+ * @type {string}
5320
+ * @memberof MetricDescriptor
5321
+ */
5322
+ label: string;
5323
+ /**
5324
+ *
5325
+ * @type {string}
5326
+ * @memberof MetricDescriptor
5327
+ */
5328
+ unit?: string;
5329
+ }
5179
5330
  /**
5180
5331
  *
5181
5332
  * @export
@@ -5617,6 +5768,20 @@ export interface ParticipantSeriesPublisherStats {
5617
5768
  global?: {
5618
5769
  [key: string]: Array<Array<number>>;
5619
5770
  };
5771
+ /**
5772
+ *
5773
+ * @type {{ [key: string]: MetricDescriptor; }}
5774
+ * @memberof ParticipantSeriesPublisherStats
5775
+ */
5776
+ global_meta?: {
5777
+ [key: string]: MetricDescriptor;
5778
+ };
5779
+ /**
5780
+ *
5781
+ * @type {Array<string>}
5782
+ * @memberof ParticipantSeriesPublisherStats
5783
+ */
5784
+ global_metrics_order?: Array<string>;
5620
5785
  /**
5621
5786
  *
5622
5787
  * @type {{ [key: string]: Array<MetricThreshold>; }}
@@ -5648,6 +5813,20 @@ export interface ParticipantSeriesSubscriberStats {
5648
5813
  global?: {
5649
5814
  [key: string]: Array<Array<number>>;
5650
5815
  };
5816
+ /**
5817
+ *
5818
+ * @type {{ [key: string]: MetricDescriptor; }}
5819
+ * @memberof ParticipantSeriesSubscriberStats
5820
+ */
5821
+ global_meta?: {
5822
+ [key: string]: MetricDescriptor;
5823
+ };
5824
+ /**
5825
+ *
5826
+ * @type {Array<string>}
5827
+ * @memberof ParticipantSeriesSubscriberStats
5828
+ */
5829
+ global_metrics_order?: Array<string>;
5651
5830
  /**
5652
5831
  *
5653
5832
  * @type {{ [key: string]: Array<MetricThreshold>; }}
@@ -5753,6 +5932,20 @@ export interface ParticipantSeriesTrackMetrics {
5753
5932
  metrics?: {
5754
5933
  [key: string]: Array<Array<number>>;
5755
5934
  };
5935
+ /**
5936
+ *
5937
+ * @type {{ [key: string]: MetricDescriptor; }}
5938
+ * @memberof ParticipantSeriesTrackMetrics
5939
+ */
5940
+ metrics_meta?: {
5941
+ [key: string]: MetricDescriptor;
5942
+ };
5943
+ /**
5944
+ *
5945
+ * @type {Array<string>}
5946
+ * @memberof ParticipantSeriesTrackMetrics
5947
+ */
5948
+ metrics_order?: Array<string>;
5756
5949
  /**
5757
5950
  *
5758
5951
  * @type {string}
@@ -5794,6 +5987,20 @@ export interface ParticipantSeriesUserStats {
5794
5987
  metrics?: {
5795
5988
  [key: string]: Array<Array<number>>;
5796
5989
  };
5990
+ /**
5991
+ *
5992
+ * @type {{ [key: string]: MetricDescriptor; }}
5993
+ * @memberof ParticipantSeriesUserStats
5994
+ */
5995
+ metrics_meta?: {
5996
+ [key: string]: MetricDescriptor;
5997
+ };
5998
+ /**
5999
+ *
6000
+ * @type {Array<string>}
6001
+ * @memberof ParticipantSeriesUserStats
6002
+ */
6003
+ metrics_order?: Array<string>;
5797
6004
  /**
5798
6005
  *
5799
6006
  * @type {{ [key: string]: Array<MetricThreshold>; }}
@@ -6541,13 +6748,11 @@ export declare const RTMPBroadcastRequestQualityEnum: {
6541
6748
  readonly _720P: "720p";
6542
6749
  readonly _1080P: "1080p";
6543
6750
  readonly _1440P: "1440p";
6544
- readonly _2160P: "2160p";
6545
6751
  readonly PORTRAIT_360X640: "portrait-360x640";
6546
6752
  readonly PORTRAIT_480X854: "portrait-480x854";
6547
6753
  readonly PORTRAIT_720X1280: "portrait-720x1280";
6548
6754
  readonly PORTRAIT_1080X1920: "portrait-1080x1920";
6549
6755
  readonly PORTRAIT_1440X2560: "portrait-1440x2560";
6550
- readonly PORTRAIT_2160X3840: "portrait-2160x3840";
6551
6756
  };
6552
6757
  export type RTMPBroadcastRequestQualityEnum = (typeof RTMPBroadcastRequestQualityEnum)[keyof typeof RTMPBroadcastRequestQualityEnum];
6553
6758
  /**
@@ -6591,13 +6796,11 @@ export declare const RTMPSettingsRequestQualityEnum: {
6591
6796
  readonly _720P: "720p";
6592
6797
  readonly _1080P: "1080p";
6593
6798
  readonly _1440P: "1440p";
6594
- readonly _2160P: "2160p";
6595
6799
  readonly PORTRAIT_360X640: "portrait-360x640";
6596
6800
  readonly PORTRAIT_480X854: "portrait-480x854";
6597
6801
  readonly PORTRAIT_720X1280: "portrait-720x1280";
6598
6802
  readonly PORTRAIT_1080X1920: "portrait-1080x1920";
6599
6803
  readonly PORTRAIT_1440X2560: "portrait-1440x2560";
6600
- readonly PORTRAIT_2160X3840: "portrait-2160x3840";
6601
6804
  };
6602
6805
  export type RTMPSettingsRequestQualityEnum = (typeof RTMPSettingsRequestQualityEnum)[keyof typeof RTMPSettingsRequestQualityEnum];
6603
6806
  /**
@@ -6695,13 +6898,11 @@ export declare const RecordSettingsRequestQualityEnum: {
6695
6898
  readonly _720P: "720p";
6696
6899
  readonly _1080P: "1080p";
6697
6900
  readonly _1440P: "1440p";
6698
- readonly _2160P: "2160p";
6699
6901
  readonly PORTRAIT_360X640: "portrait-360x640";
6700
6902
  readonly PORTRAIT_480X854: "portrait-480x854";
6701
6903
  readonly PORTRAIT_720X1280: "portrait-720x1280";
6702
6904
  readonly PORTRAIT_1080X1920: "portrait-1080x1920";
6703
6905
  readonly PORTRAIT_1440X2560: "portrait-1440x2560";
6704
- readonly PORTRAIT_2160X3840: "portrait-2160x3840";
6705
6906
  };
6706
6907
  export type RecordSettingsRequestQualityEnum = (typeof RecordSettingsRequestQualityEnum)[keyof typeof RecordSettingsRequestQualityEnum];
6707
6908
  /**
@@ -6843,6 +7044,70 @@ export interface RequestPermissionResponse {
6843
7044
  */
6844
7045
  duration: string;
6845
7046
  }
7047
+ /**
7048
+ * Request to resolve SIP inbound routing using challenge authentication
7049
+ * @export
7050
+ * @interface ResolveSipInboundRequest
7051
+ */
7052
+ export interface ResolveSipInboundRequest {
7053
+ /**
7054
+ *
7055
+ * @type {SIPChallenge}
7056
+ * @memberof ResolveSipInboundRequest
7057
+ */
7058
+ challenge: SIPChallenge;
7059
+ /**
7060
+ * SIP caller number
7061
+ * @type {string}
7062
+ * @memberof ResolveSipInboundRequest
7063
+ */
7064
+ sip_caller_number: string;
7065
+ /**
7066
+ * Optional SIP headers as key-value pairs
7067
+ * @type {{ [key: string]: string; }}
7068
+ * @memberof ResolveSipInboundRequest
7069
+ */
7070
+ sip_headers?: {
7071
+ [key: string]: string;
7072
+ };
7073
+ /**
7074
+ * SIP trunk number to resolve
7075
+ * @type {string}
7076
+ * @memberof ResolveSipInboundRequest
7077
+ */
7078
+ sip_trunk_number: string;
7079
+ }
7080
+ /**
7081
+ * Response containing resolved SIP inbound routing information
7082
+ * @export
7083
+ * @interface ResolveSipInboundResponse
7084
+ */
7085
+ export interface ResolveSipInboundResponse {
7086
+ /**
7087
+ *
7088
+ * @type {SipInboundCredentials}
7089
+ * @memberof ResolveSipInboundResponse
7090
+ */
7091
+ credentials: SipInboundCredentials;
7092
+ /**
7093
+ *
7094
+ * @type {string}
7095
+ * @memberof ResolveSipInboundResponse
7096
+ */
7097
+ duration: string;
7098
+ /**
7099
+ *
7100
+ * @type {SIPInboundRoutingRuleResponse}
7101
+ * @memberof ResolveSipInboundResponse
7102
+ */
7103
+ sip_routing_rule?: SIPInboundRoutingRuleResponse;
7104
+ /**
7105
+ *
7106
+ * @type {SIPTrunkResponse}
7107
+ * @memberof ResolveSipInboundResponse
7108
+ */
7109
+ sip_trunk?: SIPTrunkResponse;
7110
+ }
6846
7111
  /**
6847
7112
  * Basic response information
6848
7113
  * @export
@@ -6856,6 +7121,44 @@ export interface Response {
6856
7121
  */
6857
7122
  duration: string;
6858
7123
  }
7124
+ /**
7125
+ *
7126
+ * @export
7127
+ * @interface RingCallRequest
7128
+ */
7129
+ export interface RingCallRequest {
7130
+ /**
7131
+ * Members that should receive the ring. If no ids are provided, all call members who are not already in the call will receive ring notifications.
7132
+ * @type {Array<string>}
7133
+ * @memberof RingCallRequest
7134
+ */
7135
+ members_ids?: Array<string>;
7136
+ /**
7137
+ * Indicate if call should be video
7138
+ * @type {boolean}
7139
+ * @memberof RingCallRequest
7140
+ */
7141
+ video?: boolean;
7142
+ }
7143
+ /**
7144
+ *
7145
+ * @export
7146
+ * @interface RingCallResponse
7147
+ */
7148
+ export interface RingCallResponse {
7149
+ /**
7150
+ *
7151
+ * @type {string}
7152
+ * @memberof RingCallResponse
7153
+ */
7154
+ duration: string;
7155
+ /**
7156
+ * List of members ringing notification was sent to
7157
+ * @type {Array<string>}
7158
+ * @memberof RingCallResponse
7159
+ */
7160
+ members_ids: Array<string>;
7161
+ }
6859
7162
  /**
6860
7163
  *
6861
7164
  * @export
@@ -6959,6 +7262,366 @@ export interface SFUResponse {
6959
7262
  */
6960
7263
  ws_endpoint: string;
6961
7264
  }
7265
+ /**
7266
+ * SIP call configuration response
7267
+ * @export
7268
+ * @interface SIPCallConfigsResponse
7269
+ */
7270
+ export interface SIPCallConfigsResponse {
7271
+ /**
7272
+ * Custom data associated with the call
7273
+ * @type {{ [key: string]: any; }}
7274
+ * @memberof SIPCallConfigsResponse
7275
+ */
7276
+ custom_data: {
7277
+ [key: string]: any;
7278
+ };
7279
+ }
7280
+ /**
7281
+ * SIP caller configuration response
7282
+ * @export
7283
+ * @interface SIPCallerConfigsResponse
7284
+ */
7285
+ export interface SIPCallerConfigsResponse {
7286
+ /**
7287
+ * Custom data associated with the caller
7288
+ * @type {{ [key: string]: any; }}
7289
+ * @memberof SIPCallerConfigsResponse
7290
+ */
7291
+ custom_data: {
7292
+ [key: string]: any;
7293
+ };
7294
+ /**
7295
+ * Unique identifier for the caller
7296
+ * @type {string}
7297
+ * @memberof SIPCallerConfigsResponse
7298
+ */
7299
+ id: string;
7300
+ }
7301
+ /**
7302
+ *
7303
+ * @export
7304
+ * @interface SIPChallenge
7305
+ */
7306
+ export interface SIPChallenge {
7307
+ /**
7308
+ *
7309
+ * @type {string}
7310
+ * @memberof SIPChallenge
7311
+ */
7312
+ a1?: string;
7313
+ /**
7314
+ *
7315
+ * @type {string}
7316
+ * @memberof SIPChallenge
7317
+ */
7318
+ algorithm?: string;
7319
+ /**
7320
+ *
7321
+ * @type {string}
7322
+ * @memberof SIPChallenge
7323
+ */
7324
+ charset?: string;
7325
+ /**
7326
+ *
7327
+ * @type {string}
7328
+ * @memberof SIPChallenge
7329
+ */
7330
+ cnonce?: string;
7331
+ /**
7332
+ *
7333
+ * @type {Array<string>}
7334
+ * @memberof SIPChallenge
7335
+ */
7336
+ domain?: Array<string>;
7337
+ /**
7338
+ *
7339
+ * @type {string}
7340
+ * @memberof SIPChallenge
7341
+ */
7342
+ method?: string;
7343
+ /**
7344
+ *
7345
+ * @type {string}
7346
+ * @memberof SIPChallenge
7347
+ */
7348
+ nc?: string;
7349
+ /**
7350
+ *
7351
+ * @type {string}
7352
+ * @memberof SIPChallenge
7353
+ */
7354
+ nonce?: string;
7355
+ /**
7356
+ *
7357
+ * @type {string}
7358
+ * @memberof SIPChallenge
7359
+ */
7360
+ opaque?: string;
7361
+ /**
7362
+ *
7363
+ * @type {Array<string>}
7364
+ * @memberof SIPChallenge
7365
+ */
7366
+ qop?: Array<string>;
7367
+ /**
7368
+ *
7369
+ * @type {string}
7370
+ * @memberof SIPChallenge
7371
+ */
7372
+ realm?: string;
7373
+ /**
7374
+ *
7375
+ * @type {string}
7376
+ * @memberof SIPChallenge
7377
+ */
7378
+ response?: string;
7379
+ /**
7380
+ *
7381
+ * @type {boolean}
7382
+ * @memberof SIPChallenge
7383
+ */
7384
+ stale?: boolean;
7385
+ /**
7386
+ *
7387
+ * @type {string}
7388
+ * @memberof SIPChallenge
7389
+ */
7390
+ uri?: string;
7391
+ /**
7392
+ *
7393
+ * @type {boolean}
7394
+ * @memberof SIPChallenge
7395
+ */
7396
+ userhash?: boolean;
7397
+ /**
7398
+ *
7399
+ * @type {string}
7400
+ * @memberof SIPChallenge
7401
+ */
7402
+ username?: string;
7403
+ }
7404
+ /**
7405
+ * Direct routing rule call configuration response
7406
+ * @export
7407
+ * @interface SIPDirectRoutingRuleCallConfigsResponse
7408
+ */
7409
+ export interface SIPDirectRoutingRuleCallConfigsResponse {
7410
+ /**
7411
+ * ID of the call
7412
+ * @type {string}
7413
+ * @memberof SIPDirectRoutingRuleCallConfigsResponse
7414
+ */
7415
+ call_id: string;
7416
+ /**
7417
+ * Type of the call
7418
+ * @type {string}
7419
+ * @memberof SIPDirectRoutingRuleCallConfigsResponse
7420
+ */
7421
+ call_type: string;
7422
+ }
7423
+ /**
7424
+ * PIN routing rule call configuration response
7425
+ * @export
7426
+ * @interface SIPInboundRoutingRulePinConfigsResponse
7427
+ */
7428
+ export interface SIPInboundRoutingRulePinConfigsResponse {
7429
+ /**
7430
+ * Optional webhook URL for custom PIN handling
7431
+ * @type {string}
7432
+ * @memberof SIPInboundRoutingRulePinConfigsResponse
7433
+ */
7434
+ custom_webhook_url?: string;
7435
+ /**
7436
+ * Prompt message for failed PIN attempts
7437
+ * @type {string}
7438
+ * @memberof SIPInboundRoutingRulePinConfigsResponse
7439
+ */
7440
+ pin_failed_attempt_prompt?: string;
7441
+ /**
7442
+ * Prompt message for hangup after PIN input
7443
+ * @type {string}
7444
+ * @memberof SIPInboundRoutingRulePinConfigsResponse
7445
+ */
7446
+ pin_hangup_prompt?: string;
7447
+ /**
7448
+ * Prompt message for PIN input
7449
+ * @type {string}
7450
+ * @memberof SIPInboundRoutingRulePinConfigsResponse
7451
+ */
7452
+ pin_prompt?: string;
7453
+ /**
7454
+ * Prompt message for successful PIN input
7455
+ * @type {string}
7456
+ * @memberof SIPInboundRoutingRulePinConfigsResponse
7457
+ */
7458
+ pin_success_prompt?: string;
7459
+ }
7460
+ /**
7461
+ * SIP Inbound Routing Rule response
7462
+ * @export
7463
+ * @interface SIPInboundRoutingRuleResponse
7464
+ */
7465
+ export interface SIPInboundRoutingRuleResponse {
7466
+ /**
7467
+ *
7468
+ * @type {SIPCallConfigsResponse}
7469
+ * @memberof SIPInboundRoutingRuleResponse
7470
+ */
7471
+ call_configs?: SIPCallConfigsResponse;
7472
+ /**
7473
+ * List of called numbers
7474
+ * @type {Array<string>}
7475
+ * @memberof SIPInboundRoutingRuleResponse
7476
+ */
7477
+ called_numbers: Array<string>;
7478
+ /**
7479
+ *
7480
+ * @type {SIPCallerConfigsResponse}
7481
+ * @memberof SIPInboundRoutingRuleResponse
7482
+ */
7483
+ caller_configs?: SIPCallerConfigsResponse;
7484
+ /**
7485
+ * List of caller numbers
7486
+ * @type {Array<string>}
7487
+ * @memberof SIPInboundRoutingRuleResponse
7488
+ */
7489
+ caller_numbers?: Array<string>;
7490
+ /**
7491
+ *
7492
+ * @type {SIPDirectRoutingRuleCallConfigsResponse}
7493
+ * @memberof SIPInboundRoutingRuleResponse
7494
+ */
7495
+ direct_routing_configs?: SIPDirectRoutingRuleCallConfigsResponse;
7496
+ /**
7497
+ *
7498
+ * @type {string}
7499
+ * @memberof SIPInboundRoutingRuleResponse
7500
+ */
7501
+ duration: string;
7502
+ /**
7503
+ * Unique identifier of the SIP Inbound Routing Rule
7504
+ * @type {string}
7505
+ * @memberof SIPInboundRoutingRuleResponse
7506
+ */
7507
+ id: string;
7508
+ /**
7509
+ * Name of the SIP Inbound Routing Rule
7510
+ * @type {string}
7511
+ * @memberof SIPInboundRoutingRuleResponse
7512
+ */
7513
+ name: string;
7514
+ /**
7515
+ *
7516
+ * @type {SIPPinProtectionConfigsResponse}
7517
+ * @memberof SIPInboundRoutingRuleResponse
7518
+ */
7519
+ pin_protection_configs?: SIPPinProtectionConfigsResponse;
7520
+ /**
7521
+ *
7522
+ * @type {SIPInboundRoutingRulePinConfigsResponse}
7523
+ * @memberof SIPInboundRoutingRuleResponse
7524
+ */
7525
+ pin_routing_configs?: SIPInboundRoutingRulePinConfigsResponse;
7526
+ /**
7527
+ * List of SIP trunk IDs
7528
+ * @type {Array<string>}
7529
+ * @memberof SIPInboundRoutingRuleResponse
7530
+ */
7531
+ trunk_ids: Array<string>;
7532
+ /**
7533
+ *
7534
+ * @type {object}
7535
+ * @memberof SIPInboundRoutingRuleResponse
7536
+ */
7537
+ updated_at: object;
7538
+ }
7539
+ /**
7540
+ * PIN protection configuration response
7541
+ * @export
7542
+ * @interface SIPPinProtectionConfigsResponse
7543
+ */
7544
+ export interface SIPPinProtectionConfigsResponse {
7545
+ /**
7546
+ * Default PIN to use if there is no PIN set on the call object
7547
+ * @type {string}
7548
+ * @memberof SIPPinProtectionConfigsResponse
7549
+ */
7550
+ default_pin?: string;
7551
+ /**
7552
+ * Whether PIN protection is enabled
7553
+ * @type {boolean}
7554
+ * @memberof SIPPinProtectionConfigsResponse
7555
+ */
7556
+ enabled: boolean;
7557
+ /**
7558
+ * Maximum number of PIN attempts allowed
7559
+ * @type {number}
7560
+ * @memberof SIPPinProtectionConfigsResponse
7561
+ */
7562
+ max_attempts?: number;
7563
+ /**
7564
+ * Number of digits required for the PIN
7565
+ * @type {number}
7566
+ * @memberof SIPPinProtectionConfigsResponse
7567
+ */
7568
+ required_pin_digits?: number;
7569
+ }
7570
+ /**
7571
+ * SIP trunk information
7572
+ * @export
7573
+ * @interface SIPTrunkResponse
7574
+ */
7575
+ export interface SIPTrunkResponse {
7576
+ /**
7577
+ *
7578
+ * @type {object}
7579
+ * @memberof SIPTrunkResponse
7580
+ */
7581
+ created_at: object;
7582
+ /**
7583
+ * Unique identifier for the SIP trunk
7584
+ * @type {string}
7585
+ * @memberof SIPTrunkResponse
7586
+ */
7587
+ id: string;
7588
+ /**
7589
+ * Name of the SIP trunk
7590
+ * @type {string}
7591
+ * @memberof SIPTrunkResponse
7592
+ */
7593
+ name: string;
7594
+ /**
7595
+ * Phone numbers associated with this SIP trunk
7596
+ * @type {Array<string>}
7597
+ * @memberof SIPTrunkResponse
7598
+ */
7599
+ numbers: Array<string>;
7600
+ /**
7601
+ * Password for SIP trunk authentication
7602
+ * @type {string}
7603
+ * @memberof SIPTrunkResponse
7604
+ */
7605
+ password: string;
7606
+ /**
7607
+ *
7608
+ * @type {object}
7609
+ * @memberof SIPTrunkResponse
7610
+ */
7611
+ updated_at: object;
7612
+ /**
7613
+ * The URI for the SIP trunk
7614
+ * @type {string}
7615
+ * @memberof SIPTrunkResponse
7616
+ */
7617
+ uri: string;
7618
+ /**
7619
+ * Username for SIP trunk authentication
7620
+ * @type {string}
7621
+ * @memberof SIPTrunkResponse
7622
+ */
7623
+ username: string;
7624
+ }
6962
7625
  /**
6963
7626
  *
6964
7627
  * @export
@@ -7122,6 +7785,53 @@ export interface SessionSettingsResponse {
7122
7785
  */
7123
7786
  inactivity_timeout_seconds: number;
7124
7787
  }
7788
+ /**
7789
+ * Credentials for SIP inbound call authentication
7790
+ * @export
7791
+ * @interface SipInboundCredentials
7792
+ */
7793
+ export interface SipInboundCredentials {
7794
+ /**
7795
+ * Custom data associated with the call
7796
+ * @type {{ [key: string]: any; }}
7797
+ * @memberof SipInboundCredentials
7798
+ */
7799
+ call_custom_data: {
7800
+ [key: string]: any;
7801
+ };
7802
+ /**
7803
+ * ID of the call
7804
+ * @type {string}
7805
+ * @memberof SipInboundCredentials
7806
+ */
7807
+ call_id: string;
7808
+ /**
7809
+ * Type of the call
7810
+ * @type {string}
7811
+ * @memberof SipInboundCredentials
7812
+ */
7813
+ call_type: string;
7814
+ /**
7815
+ * Authentication token for the call
7816
+ * @type {string}
7817
+ * @memberof SipInboundCredentials
7818
+ */
7819
+ token: string;
7820
+ /**
7821
+ * Custom data associated with the user
7822
+ * @type {{ [key: string]: any; }}
7823
+ * @memberof SipInboundCredentials
7824
+ */
7825
+ user_custom_data: {
7826
+ [key: string]: any;
7827
+ };
7828
+ /**
7829
+ * User ID for the call
7830
+ * @type {string}
7831
+ * @memberof SipInboundCredentials
7832
+ */
7833
+ user_id: string;
7834
+ }
7125
7835
  /**
7126
7836
  *
7127
7837
  * @export