telnyx 5.164.0 → 5.166.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +26 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +4 -5
- data/lib/telnyx/lib/webhook_verification.rb +54 -155
- data/lib/telnyx/lib.rb +3 -1
- data/lib/telnyx/models/ai/assistant_tool.rb +14 -1
- data/lib/telnyx/models/ai/transcription_settings.rb +20 -15
- data/lib/telnyx/models/ai/transcription_settings_config.rb +35 -10
- data/lib/telnyx/models/call_dial_params.rb +13 -1
- data/lib/telnyx/models/calls/action_transfer_params.rb +13 -1
- data/lib/telnyx/models/connection_rtcp_settings.rb +3 -3
- data/lib/telnyx/models/credential_connections/action_check_registration_status_response.rb +12 -12
- data/lib/telnyx/models/external_requirements/sub_number_order_retrieve_params.rb +28 -0
- data/lib/telnyx/models/external_requirements/sub_number_order_retrieve_response.rb +104 -0
- data/lib/telnyx/models/external_requirements/sub_number_order_update_params.rb +69 -0
- data/lib/telnyx/models/external_requirements/sub_number_order_update_response.rb +66 -0
- data/lib/telnyx/models/outbound_voice_profile.rb +14 -14
- data/lib/telnyx/models/outbound_voice_profile_create_params.rb +14 -14
- data/lib/telnyx/models/outbound_voice_profile_update_params.rb +14 -14
- data/lib/telnyx/models/uac_connections/action_check_registration_status_response.rb +12 -12
- data/lib/telnyx/models.rb +2 -2
- data/lib/telnyx/resources/calls/actions.rb +3 -1
- data/lib/telnyx/resources/calls.rb +3 -1
- data/lib/telnyx/resources/credential_connections/actions.rb +3 -3
- data/lib/telnyx/resources/external_requirements/sub_number_orders.rb +99 -0
- data/lib/telnyx/resources/external_requirements.rb +19 -0
- data/lib/telnyx/resources/outbound_voice_profiles.rb +2 -2
- data/lib/telnyx/resources/uac_connections/actions.rb +3 -3
- data/lib/telnyx/resources/webhooks.rb +1 -1
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +6 -4
- data/rbi/telnyx/client.rbi +3 -4
- data/rbi/telnyx/models/ai/assistant_tool.rbi +21 -0
- data/rbi/telnyx/models/ai/transcription_settings.rbi +40 -28
- data/rbi/telnyx/models/ai/transcription_settings_config.rbi +52 -12
- data/rbi/telnyx/models/call_dial_params.rbi +19 -0
- data/rbi/telnyx/models/calls/action_transfer_params.rbi +19 -0
- data/rbi/telnyx/models/connection_rtcp_settings.rbi +4 -4
- data/rbi/telnyx/models/credential_connections/action_check_registration_status_response.rbi +18 -36
- data/rbi/telnyx/models/external_requirements/sub_number_order_retrieve_params.rbi +52 -0
- data/rbi/telnyx/models/external_requirements/sub_number_order_retrieve_response.rbi +248 -0
- data/rbi/telnyx/models/external_requirements/sub_number_order_update_params.rbi +119 -0
- data/rbi/telnyx/models/external_requirements/sub_number_order_update_response.rbi +159 -0
- data/rbi/telnyx/models/outbound_voice_profile.rbi +18 -18
- data/rbi/telnyx/models/outbound_voice_profile_create_params.rbi +18 -18
- data/rbi/telnyx/models/outbound_voice_profile_update_params.rbi +18 -18
- data/rbi/telnyx/models/uac_connections/action_check_registration_status_response.rbi +18 -36
- data/rbi/telnyx/models.rbi +2 -3
- data/rbi/telnyx/resources/calls/actions.rbi +7 -0
- data/rbi/telnyx/resources/calls.rbi +7 -0
- data/rbi/telnyx/resources/credential_connections/actions.rbi +3 -3
- data/rbi/telnyx/resources/external_requirements/sub_number_orders.rbi +71 -0
- data/rbi/telnyx/resources/external_requirements.rbi +16 -0
- data/rbi/telnyx/resources/outbound_voice_profiles.rbi +4 -4
- data/rbi/telnyx/resources/uac_connections/actions.rbi +3 -3
- data/sig/telnyx/client.rbs +2 -2
- data/sig/telnyx/models/ai/assistant_tool.rbs +7 -0
- data/sig/telnyx/models/ai/transcription_settings.rbs +2 -0
- data/sig/telnyx/models/ai/transcription_settings_config.rbs +14 -0
- data/sig/telnyx/models/call_dial_params.rbs +7 -0
- data/sig/telnyx/models/calls/action_transfer_params.rbs +7 -0
- data/sig/telnyx/models/credential_connections/action_check_registration_status_response.rbs +24 -36
- data/sig/telnyx/models/external_requirements/sub_number_order_retrieve_params.rbs +30 -0
- data/sig/telnyx/models/external_requirements/sub_number_order_retrieve_response.rbs +110 -0
- data/sig/telnyx/models/external_requirements/sub_number_order_update_params.rbs +50 -0
- data/sig/telnyx/models/external_requirements/sub_number_order_update_response.rbs +75 -0
- data/sig/telnyx/models/uac_connections/action_check_registration_status_response.rbs +24 -36
- data/sig/telnyx/models.rbs +2 -2
- data/sig/telnyx/resources/calls/actions.rbs +1 -0
- data/sig/telnyx/resources/calls.rbs +1 -0
- data/sig/telnyx/resources/external_requirements/sub_number_orders.rbs +22 -0
- data/sig/telnyx/resources/external_requirements.rbs +9 -0
- metadata +20 -26
- data/lib/telnyx/lib/webhooks_ed25519.rb +0 -63
- data/lib/telnyx/models/sip_registration_status_retrieve_params.rb +0 -59
- data/lib/telnyx/models/sip_registration_status_retrieve_response.rb +0 -214
- data/lib/telnyx/resources/sip_registration_status.rb +0 -59
- data/rbi/telnyx/models/sip_registration_status_retrieve_params.rbi +0 -124
- data/rbi/telnyx/models/sip_registration_status_retrieve_response.rbi +0 -416
- data/rbi/telnyx/resources/sip_registration_status.rbi +0 -52
- data/sig/telnyx/models/sip_registration_status_retrieve_params.rbs +0 -55
- data/sig/telnyx/models/sip_registration_status_retrieve_response.rbs +0 -195
- data/sig/telnyx/resources/sip_registration_status.rbs +0 -14
|
@@ -19,19 +19,19 @@ module Telnyx
|
|
|
19
19
|
# The ip used during the SIP connection
|
|
20
20
|
#
|
|
21
21
|
# @return [String, nil]
|
|
22
|
-
optional :ip_address, String
|
|
22
|
+
optional :ip_address, String, nil?: true
|
|
23
23
|
|
|
24
24
|
# @!attribute last_registration
|
|
25
25
|
# ISO 8601 formatted date indicating when the resource was last updated.
|
|
26
26
|
#
|
|
27
27
|
# @return [String, nil]
|
|
28
|
-
optional :last_registration, String
|
|
28
|
+
optional :last_registration, String, nil?: true
|
|
29
29
|
|
|
30
30
|
# @!attribute port
|
|
31
31
|
# The port of the SIP connection
|
|
32
32
|
#
|
|
33
33
|
# @return [Integer, nil]
|
|
34
|
-
optional :port, Integer
|
|
34
|
+
optional :port, Integer, nil?: true
|
|
35
35
|
|
|
36
36
|
# @!attribute record_type
|
|
37
37
|
# Identifies the type of the resource.
|
|
@@ -43,7 +43,7 @@ module Telnyx
|
|
|
43
43
|
# The user name of the SIP connection
|
|
44
44
|
#
|
|
45
45
|
# @return [String, nil]
|
|
46
|
-
optional :sip_username, String
|
|
46
|
+
optional :sip_username, String, nil?: true
|
|
47
47
|
|
|
48
48
|
# @!attribute status
|
|
49
49
|
# The current registration status of your SIP connection
|
|
@@ -56,30 +56,30 @@ module Telnyx
|
|
|
56
56
|
# The protocol of the SIP connection
|
|
57
57
|
#
|
|
58
58
|
# @return [String, nil]
|
|
59
|
-
optional :transport, String
|
|
59
|
+
optional :transport, String, nil?: true
|
|
60
60
|
|
|
61
61
|
# @!attribute user_agent
|
|
62
62
|
# The user agent of the SIP connection
|
|
63
63
|
#
|
|
64
64
|
# @return [String, nil]
|
|
65
|
-
optional :user_agent, String
|
|
65
|
+
optional :user_agent, String, nil?: true
|
|
66
66
|
|
|
67
67
|
# @!method initialize(ip_address: nil, last_registration: nil, port: nil, record_type: nil, sip_username: nil, status: nil, transport: nil, user_agent: nil)
|
|
68
|
-
# @param ip_address [String] The ip used during the SIP connection
|
|
68
|
+
# @param ip_address [String, nil] The ip used during the SIP connection
|
|
69
69
|
#
|
|
70
|
-
# @param last_registration [String] ISO 8601 formatted date indicating when the resource was last updated.
|
|
70
|
+
# @param last_registration [String, nil] ISO 8601 formatted date indicating when the resource was last updated.
|
|
71
71
|
#
|
|
72
|
-
# @param port [Integer] The port of the SIP connection
|
|
72
|
+
# @param port [Integer, nil] The port of the SIP connection
|
|
73
73
|
#
|
|
74
74
|
# @param record_type [String] Identifies the type of the resource.
|
|
75
75
|
#
|
|
76
|
-
# @param sip_username [String] The user name of the SIP connection
|
|
76
|
+
# @param sip_username [String, nil] The user name of the SIP connection
|
|
77
77
|
#
|
|
78
78
|
# @param status [Symbol, Telnyx::Models::CredentialConnections::ActionCheckRegistrationStatusResponse::Data::Status] The current registration status of your SIP connection
|
|
79
79
|
#
|
|
80
|
-
# @param transport [String] The protocol of the SIP connection
|
|
80
|
+
# @param transport [String, nil] The protocol of the SIP connection
|
|
81
81
|
#
|
|
82
|
-
# @param user_agent [String] The user agent of the SIP connection
|
|
82
|
+
# @param user_agent [String, nil] The user agent of the SIP connection
|
|
83
83
|
|
|
84
84
|
# The current registration status of your SIP connection
|
|
85
85
|
#
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module ExternalRequirements
|
|
6
|
+
# @see Telnyx::Resources::ExternalRequirements::SubNumberOrders#retrieve
|
|
7
|
+
class SubNumberOrderRetrieveParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute regulatory_requirement_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :regulatory_requirement_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute sub_number_order_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :sub_number_order_id, String
|
|
20
|
+
|
|
21
|
+
# @!method initialize(regulatory_requirement_id:, sub_number_order_id:, request_options: {})
|
|
22
|
+
# @param regulatory_requirement_id [String]
|
|
23
|
+
# @param sub_number_order_id [String]
|
|
24
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module ExternalRequirements
|
|
6
|
+
# @see Telnyx::Resources::ExternalRequirements::SubNumberOrders#retrieve
|
|
7
|
+
class SubNumberOrderRetrieveResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data, nil]
|
|
11
|
+
optional :data, -> { Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data]
|
|
15
|
+
|
|
16
|
+
# @see Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse#data
|
|
17
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
18
|
+
# @!attribute fields_required
|
|
19
|
+
# The fields the end user must provide to fulfill this requirement.
|
|
20
|
+
#
|
|
21
|
+
# @return [Array<Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::FieldsRequired>, nil]
|
|
22
|
+
optional :fields_required,
|
|
23
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::FieldsRequired] }
|
|
24
|
+
|
|
25
|
+
# @!attribute regulatory_requirement_id
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :regulatory_requirement_id, String
|
|
29
|
+
|
|
30
|
+
# @!attribute requirement_action
|
|
31
|
+
#
|
|
32
|
+
# @return [Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::RequirementAction, nil]
|
|
33
|
+
optional :requirement_action,
|
|
34
|
+
-> { Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::RequirementAction }
|
|
35
|
+
|
|
36
|
+
# @!method initialize(fields_required: nil, regulatory_requirement_id: nil, requirement_action: nil)
|
|
37
|
+
# @param fields_required [Array<Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::FieldsRequired>] The fields the end user must provide to fulfill this requirement.
|
|
38
|
+
#
|
|
39
|
+
# @param regulatory_requirement_id [String]
|
|
40
|
+
#
|
|
41
|
+
# @param requirement_action [Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::RequirementAction]
|
|
42
|
+
|
|
43
|
+
class FieldsRequired < Telnyx::Internal::Type::BaseModel
|
|
44
|
+
# @!attribute description
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :description, String
|
|
48
|
+
|
|
49
|
+
# @!attribute name
|
|
50
|
+
# The field name to send inside the `requirement` object on the POST.
|
|
51
|
+
#
|
|
52
|
+
# @return [String, nil]
|
|
53
|
+
optional :name, String
|
|
54
|
+
|
|
55
|
+
# @!attribute type
|
|
56
|
+
#
|
|
57
|
+
# @return [String, nil]
|
|
58
|
+
optional :type, String
|
|
59
|
+
|
|
60
|
+
# @!attribute value
|
|
61
|
+
# The value already stored for this field, or null if not yet provided.
|
|
62
|
+
#
|
|
63
|
+
# @return [String, nil]
|
|
64
|
+
optional :value, String, nil?: true
|
|
65
|
+
|
|
66
|
+
# @!method initialize(description: nil, name: nil, type: nil, value: nil)
|
|
67
|
+
# @param description [String]
|
|
68
|
+
#
|
|
69
|
+
# @param name [String] The field name to send inside the `requirement` object on the POST.
|
|
70
|
+
#
|
|
71
|
+
# @param type [String]
|
|
72
|
+
#
|
|
73
|
+
# @param value [String, nil] The value already stored for this field, or null if not yet provided.
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# @see Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data#requirement_action
|
|
77
|
+
class RequirementAction < Telnyx::Internal::Type::BaseModel
|
|
78
|
+
# @!attribute type
|
|
79
|
+
# The type of action the end user must complete.
|
|
80
|
+
#
|
|
81
|
+
# @return [String, nil]
|
|
82
|
+
optional :type, String
|
|
83
|
+
|
|
84
|
+
# @!attribute value
|
|
85
|
+
# The action value. For ID verification this is the verification link URL, or null
|
|
86
|
+
# until it has been generated.
|
|
87
|
+
#
|
|
88
|
+
# @return [String, nil]
|
|
89
|
+
optional :value, String, nil?: true
|
|
90
|
+
|
|
91
|
+
# @!method initialize(type: nil, value: nil)
|
|
92
|
+
# Some parameter documentations has been truncated, see
|
|
93
|
+
# {Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::RequirementAction}
|
|
94
|
+
# for more details.
|
|
95
|
+
#
|
|
96
|
+
# @param type [String] The type of action the end user must complete.
|
|
97
|
+
#
|
|
98
|
+
# @param value [String, nil] The action value. For ID verification this is the verification link URL, or null
|
|
99
|
+
end
|
|
100
|
+
end
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
end
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module ExternalRequirements
|
|
6
|
+
# @see Telnyx::Resources::ExternalRequirements::SubNumberOrders#update
|
|
7
|
+
class SubNumberOrderUpdateParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute regulatory_requirement_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :regulatory_requirement_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute sub_number_order_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :sub_number_order_id, String
|
|
20
|
+
|
|
21
|
+
# @!attribute requirement
|
|
22
|
+
# The end user's identity details for the action requirement. Australia mobile ID
|
|
23
|
+
# verification is currently the only action requirement. It requires `first_name`
|
|
24
|
+
# and `last_name`, the same fields the corresponding GET lists in
|
|
25
|
+
# `fields_required`.
|
|
26
|
+
#
|
|
27
|
+
# @return [Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateParams::Requirement]
|
|
28
|
+
required :requirement, -> { Telnyx::ExternalRequirements::SubNumberOrderUpdateParams::Requirement }
|
|
29
|
+
|
|
30
|
+
# @!method initialize(regulatory_requirement_id:, sub_number_order_id:, requirement:, request_options: {})
|
|
31
|
+
# Some parameter documentations has been truncated, see
|
|
32
|
+
# {Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateParams} for more
|
|
33
|
+
# details.
|
|
34
|
+
#
|
|
35
|
+
# @param regulatory_requirement_id [String]
|
|
36
|
+
#
|
|
37
|
+
# @param sub_number_order_id [String]
|
|
38
|
+
#
|
|
39
|
+
# @param requirement [Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateParams::Requirement] The end user's identity details for the action requirement. Australia mobile ID
|
|
40
|
+
#
|
|
41
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
42
|
+
|
|
43
|
+
class Requirement < Telnyx::Internal::Type::BaseModel
|
|
44
|
+
# @!attribute first_name
|
|
45
|
+
# The end user's first name.
|
|
46
|
+
#
|
|
47
|
+
# @return [String]
|
|
48
|
+
required :first_name, String
|
|
49
|
+
|
|
50
|
+
# @!attribute last_name
|
|
51
|
+
# The end user's last name.
|
|
52
|
+
#
|
|
53
|
+
# @return [String]
|
|
54
|
+
required :last_name, String
|
|
55
|
+
|
|
56
|
+
# @!method initialize(first_name:, last_name:)
|
|
57
|
+
# The end user's identity details for the action requirement. Australia mobile ID
|
|
58
|
+
# verification is currently the only action requirement. It requires `first_name`
|
|
59
|
+
# and `last_name`, the same fields the corresponding GET lists in
|
|
60
|
+
# `fields_required`.
|
|
61
|
+
#
|
|
62
|
+
# @param first_name [String] The end user's first name.
|
|
63
|
+
#
|
|
64
|
+
# @param last_name [String] The end user's last name.
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
end
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module ExternalRequirements
|
|
6
|
+
# @see Telnyx::Resources::ExternalRequirements::SubNumberOrders#update
|
|
7
|
+
class SubNumberOrderUpdateResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute data
|
|
9
|
+
#
|
|
10
|
+
# @return [Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data, nil]
|
|
11
|
+
optional :data, -> { Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data }
|
|
12
|
+
|
|
13
|
+
# @!method initialize(data: nil)
|
|
14
|
+
# @param data [Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data]
|
|
15
|
+
|
|
16
|
+
# @see Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse#data
|
|
17
|
+
class Data < Telnyx::Internal::Type::BaseModel
|
|
18
|
+
# @!attribute regulatory_requirement_id
|
|
19
|
+
#
|
|
20
|
+
# @return [String, nil]
|
|
21
|
+
optional :regulatory_requirement_id, String
|
|
22
|
+
|
|
23
|
+
# @!attribute requirement_action
|
|
24
|
+
#
|
|
25
|
+
# @return [Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data::RequirementAction, nil]
|
|
26
|
+
optional :requirement_action,
|
|
27
|
+
-> { Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data::RequirementAction }
|
|
28
|
+
|
|
29
|
+
# @!attribute sub_order_id
|
|
30
|
+
#
|
|
31
|
+
# @return [String, nil]
|
|
32
|
+
optional :sub_order_id, String
|
|
33
|
+
|
|
34
|
+
# @!method initialize(regulatory_requirement_id: nil, requirement_action: nil, sub_order_id: nil)
|
|
35
|
+
# @param regulatory_requirement_id [String]
|
|
36
|
+
# @param requirement_action [Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data::RequirementAction]
|
|
37
|
+
# @param sub_order_id [String]
|
|
38
|
+
|
|
39
|
+
# @see Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data#requirement_action
|
|
40
|
+
class RequirementAction < Telnyx::Internal::Type::BaseModel
|
|
41
|
+
# @!attribute type
|
|
42
|
+
#
|
|
43
|
+
# @return [String, nil]
|
|
44
|
+
optional :type, String
|
|
45
|
+
|
|
46
|
+
# @!attribute value
|
|
47
|
+
# For Australia mobile ID verification, the unique Onfido verification link to
|
|
48
|
+
# share with the end user.
|
|
49
|
+
#
|
|
50
|
+
# @return [String, nil]
|
|
51
|
+
optional :value, String, nil?: true
|
|
52
|
+
|
|
53
|
+
# @!method initialize(type: nil, value: nil)
|
|
54
|
+
# Some parameter documentations has been truncated, see
|
|
55
|
+
# {Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data::RequirementAction}
|
|
56
|
+
# for more details.
|
|
57
|
+
#
|
|
58
|
+
# @param type [String]
|
|
59
|
+
#
|
|
60
|
+
# @param value [String, nil] For Australia mobile ID verification, the unique Onfido verification link to sha
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
end
|
|
@@ -29,8 +29,8 @@ module Telnyx
|
|
|
29
29
|
optional :call_recording, -> { Telnyx::OutboundCallRecording }
|
|
30
30
|
|
|
31
31
|
# @!attribute calling_window
|
|
32
|
-
#
|
|
33
|
-
#
|
|
32
|
+
# Specifies the time window and call limits for calls made using this outbound
|
|
33
|
+
# voice profile. Note that all times are UTC in 24-hour clock time.
|
|
34
34
|
#
|
|
35
35
|
# @return [Telnyx::Models::OutboundVoiceProfile::CallingWindow, nil]
|
|
36
36
|
optional :calling_window, -> { Telnyx::OutboundVoiceProfile::CallingWindow }
|
|
@@ -135,7 +135,7 @@ module Telnyx
|
|
|
135
135
|
#
|
|
136
136
|
# @param call_recording [Telnyx::Models::OutboundCallRecording]
|
|
137
137
|
#
|
|
138
|
-
# @param calling_window [Telnyx::Models::OutboundVoiceProfile::CallingWindow]
|
|
138
|
+
# @param calling_window [Telnyx::Models::OutboundVoiceProfile::CallingWindow] Specifies the time window and call limits for calls made using this outbound voi
|
|
139
139
|
#
|
|
140
140
|
# @param concurrent_call_limit [Integer, nil] Must be no more than your global concurrent call limit. Null means no limit.
|
|
141
141
|
#
|
|
@@ -168,22 +168,22 @@ module Telnyx
|
|
|
168
168
|
# @see Telnyx::Models::OutboundVoiceProfile#calling_window
|
|
169
169
|
class CallingWindow < Telnyx::Internal::Type::BaseModel
|
|
170
170
|
# @!attribute calls_per_cld
|
|
171
|
-
#
|
|
172
|
-
#
|
|
171
|
+
# The maximum number of calls that can be initiated to a single called party (CLD)
|
|
172
|
+
# within the calling window. A null value means no limit.
|
|
173
173
|
#
|
|
174
174
|
# @return [Integer, nil]
|
|
175
175
|
optional :calls_per_cld, Integer
|
|
176
176
|
|
|
177
177
|
# @!attribute end_time
|
|
178
|
-
#
|
|
179
|
-
#
|
|
178
|
+
# The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
|
|
179
|
+
# allowed to start.
|
|
180
180
|
#
|
|
181
181
|
# @return [String, nil]
|
|
182
182
|
optional :end_time, String
|
|
183
183
|
|
|
184
184
|
# @!attribute start_time
|
|
185
|
-
#
|
|
186
|
-
#
|
|
185
|
+
# The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
|
|
186
|
+
# start.
|
|
187
187
|
#
|
|
188
188
|
# @return [String, nil]
|
|
189
189
|
optional :start_time, String
|
|
@@ -192,14 +192,14 @@ module Telnyx
|
|
|
192
192
|
# Some parameter documentations has been truncated, see
|
|
193
193
|
# {Telnyx::Models::OutboundVoiceProfile::CallingWindow} for more details.
|
|
194
194
|
#
|
|
195
|
-
#
|
|
196
|
-
#
|
|
195
|
+
# Specifies the time window and call limits for calls made using this outbound
|
|
196
|
+
# voice profile. Note that all times are UTC in 24-hour clock time.
|
|
197
197
|
#
|
|
198
|
-
# @param calls_per_cld [Integer]
|
|
198
|
+
# @param calls_per_cld [Integer] The maximum number of calls that can be initiated to a single called party (CLD)
|
|
199
199
|
#
|
|
200
|
-
# @param end_time [String]
|
|
200
|
+
# @param end_time [String] The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer al
|
|
201
201
|
#
|
|
202
|
-
# @param start_time [String]
|
|
202
|
+
# @param start_time [String] The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to s
|
|
203
203
|
end
|
|
204
204
|
end
|
|
205
205
|
end
|
|
@@ -26,8 +26,8 @@ module Telnyx
|
|
|
26
26
|
optional :call_recording, -> { Telnyx::OutboundCallRecording }
|
|
27
27
|
|
|
28
28
|
# @!attribute calling_window
|
|
29
|
-
#
|
|
30
|
-
#
|
|
29
|
+
# Specifies the time window and call limits for calls made using this outbound
|
|
30
|
+
# voice profile. Note that all times are UTC in 24-hour clock time.
|
|
31
31
|
#
|
|
32
32
|
# @return [Telnyx::Models::OutboundVoiceProfileCreateParams::CallingWindow, nil]
|
|
33
33
|
optional :calling_window, -> { Telnyx::OutboundVoiceProfileCreateParams::CallingWindow }
|
|
@@ -106,7 +106,7 @@ module Telnyx
|
|
|
106
106
|
#
|
|
107
107
|
# @param call_recording [Telnyx::Models::OutboundCallRecording]
|
|
108
108
|
#
|
|
109
|
-
# @param calling_window [Telnyx::Models::OutboundVoiceProfileCreateParams::CallingWindow]
|
|
109
|
+
# @param calling_window [Telnyx::Models::OutboundVoiceProfileCreateParams::CallingWindow] Specifies the time window and call limits for calls made using this outbound voi
|
|
110
110
|
#
|
|
111
111
|
# @param concurrent_call_limit [Integer, nil] Must be no more than your global concurrent call limit. Null means no limit.
|
|
112
112
|
#
|
|
@@ -132,22 +132,22 @@ module Telnyx
|
|
|
132
132
|
|
|
133
133
|
class CallingWindow < Telnyx::Internal::Type::BaseModel
|
|
134
134
|
# @!attribute calls_per_cld
|
|
135
|
-
#
|
|
136
|
-
#
|
|
135
|
+
# The maximum number of calls that can be initiated to a single called party (CLD)
|
|
136
|
+
# within the calling window. A null value means no limit.
|
|
137
137
|
#
|
|
138
138
|
# @return [Integer, nil]
|
|
139
139
|
optional :calls_per_cld, Integer
|
|
140
140
|
|
|
141
141
|
# @!attribute end_time
|
|
142
|
-
#
|
|
143
|
-
#
|
|
142
|
+
# The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
|
|
143
|
+
# allowed to start.
|
|
144
144
|
#
|
|
145
145
|
# @return [Time, nil]
|
|
146
146
|
optional :end_time, Time
|
|
147
147
|
|
|
148
148
|
# @!attribute start_time
|
|
149
|
-
#
|
|
150
|
-
#
|
|
149
|
+
# The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
|
|
150
|
+
# start.
|
|
151
151
|
#
|
|
152
152
|
# @return [Time, nil]
|
|
153
153
|
optional :start_time, Time
|
|
@@ -157,14 +157,14 @@ module Telnyx
|
|
|
157
157
|
# {Telnyx::Models::OutboundVoiceProfileCreateParams::CallingWindow} for more
|
|
158
158
|
# details.
|
|
159
159
|
#
|
|
160
|
-
#
|
|
161
|
-
#
|
|
160
|
+
# Specifies the time window and call limits for calls made using this outbound
|
|
161
|
+
# voice profile. Note that all times are UTC in 24-hour clock time.
|
|
162
162
|
#
|
|
163
|
-
# @param calls_per_cld [Integer]
|
|
163
|
+
# @param calls_per_cld [Integer] The maximum number of calls that can be initiated to a single called party (CLD)
|
|
164
164
|
#
|
|
165
|
-
# @param end_time [Time]
|
|
165
|
+
# @param end_time [Time] The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer al
|
|
166
166
|
#
|
|
167
|
-
# @param start_time [Time]
|
|
167
|
+
# @param start_time [Time] The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to s
|
|
168
168
|
end
|
|
169
169
|
end
|
|
170
170
|
end
|
|
@@ -31,8 +31,8 @@ module Telnyx
|
|
|
31
31
|
optional :call_recording, -> { Telnyx::OutboundCallRecording }
|
|
32
32
|
|
|
33
33
|
# @!attribute calling_window
|
|
34
|
-
#
|
|
35
|
-
#
|
|
34
|
+
# Specifies the time window and call limits for calls made using this outbound
|
|
35
|
+
# voice profile.
|
|
36
36
|
#
|
|
37
37
|
# @return [Telnyx::Models::OutboundVoiceProfileUpdateParams::CallingWindow, nil]
|
|
38
38
|
optional :calling_window, -> { Telnyx::OutboundVoiceProfileUpdateParams::CallingWindow }
|
|
@@ -113,7 +113,7 @@ module Telnyx
|
|
|
113
113
|
#
|
|
114
114
|
# @param call_recording [Telnyx::Models::OutboundCallRecording]
|
|
115
115
|
#
|
|
116
|
-
# @param calling_window [Telnyx::Models::OutboundVoiceProfileUpdateParams::CallingWindow]
|
|
116
|
+
# @param calling_window [Telnyx::Models::OutboundVoiceProfileUpdateParams::CallingWindow] Specifies the time window and call limits for calls made using this outbound voi
|
|
117
117
|
#
|
|
118
118
|
# @param concurrent_call_limit [Integer, nil] Must be no more than your global concurrent call limit. Null means no limit.
|
|
119
119
|
#
|
|
@@ -139,22 +139,22 @@ module Telnyx
|
|
|
139
139
|
|
|
140
140
|
class CallingWindow < Telnyx::Internal::Type::BaseModel
|
|
141
141
|
# @!attribute calls_per_cld
|
|
142
|
-
#
|
|
143
|
-
#
|
|
142
|
+
# The maximum number of calls that can be initiated to a single called party (CLD)
|
|
143
|
+
# within the calling window. A null value means no limit.
|
|
144
144
|
#
|
|
145
145
|
# @return [Integer, nil]
|
|
146
146
|
optional :calls_per_cld, Integer
|
|
147
147
|
|
|
148
148
|
# @!attribute end_time
|
|
149
|
-
#
|
|
150
|
-
#
|
|
149
|
+
# The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
|
|
150
|
+
# allowed to start.
|
|
151
151
|
#
|
|
152
152
|
# @return [Time, nil]
|
|
153
153
|
optional :end_time, Time
|
|
154
154
|
|
|
155
155
|
# @!attribute start_time
|
|
156
|
-
#
|
|
157
|
-
#
|
|
156
|
+
# The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
|
|
157
|
+
# start.
|
|
158
158
|
#
|
|
159
159
|
# @return [Time, nil]
|
|
160
160
|
optional :start_time, Time
|
|
@@ -164,14 +164,14 @@ module Telnyx
|
|
|
164
164
|
# {Telnyx::Models::OutboundVoiceProfileUpdateParams::CallingWindow} for more
|
|
165
165
|
# details.
|
|
166
166
|
#
|
|
167
|
-
#
|
|
168
|
-
#
|
|
167
|
+
# Specifies the time window and call limits for calls made using this outbound
|
|
168
|
+
# voice profile.
|
|
169
169
|
#
|
|
170
|
-
# @param calls_per_cld [Integer]
|
|
170
|
+
# @param calls_per_cld [Integer] The maximum number of calls that can be initiated to a single called party (CLD)
|
|
171
171
|
#
|
|
172
|
-
# @param end_time [Time]
|
|
172
|
+
# @param end_time [Time] The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer al
|
|
173
173
|
#
|
|
174
|
-
# @param start_time [Time]
|
|
174
|
+
# @param start_time [Time] The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to s
|
|
175
175
|
end
|
|
176
176
|
end
|
|
177
177
|
end
|
|
@@ -19,19 +19,19 @@ module Telnyx
|
|
|
19
19
|
# The ip used during the SIP connection
|
|
20
20
|
#
|
|
21
21
|
# @return [String, nil]
|
|
22
|
-
optional :ip_address, String
|
|
22
|
+
optional :ip_address, String, nil?: true
|
|
23
23
|
|
|
24
24
|
# @!attribute last_registration
|
|
25
25
|
# ISO 8601 formatted date indicating when the resource was last updated.
|
|
26
26
|
#
|
|
27
27
|
# @return [String, nil]
|
|
28
|
-
optional :last_registration, String
|
|
28
|
+
optional :last_registration, String, nil?: true
|
|
29
29
|
|
|
30
30
|
# @!attribute port
|
|
31
31
|
# The port of the SIP connection
|
|
32
32
|
#
|
|
33
33
|
# @return [Integer, nil]
|
|
34
|
-
optional :port, Integer
|
|
34
|
+
optional :port, Integer, nil?: true
|
|
35
35
|
|
|
36
36
|
# @!attribute record_type
|
|
37
37
|
# Identifies the type of the resource.
|
|
@@ -43,7 +43,7 @@ module Telnyx
|
|
|
43
43
|
# The user name of the SIP connection
|
|
44
44
|
#
|
|
45
45
|
# @return [String, nil]
|
|
46
|
-
optional :sip_username, String
|
|
46
|
+
optional :sip_username, String, nil?: true
|
|
47
47
|
|
|
48
48
|
# @!attribute status
|
|
49
49
|
# The current registration status of your SIP connection
|
|
@@ -56,30 +56,30 @@ module Telnyx
|
|
|
56
56
|
# The protocol of the SIP connection
|
|
57
57
|
#
|
|
58
58
|
# @return [String, nil]
|
|
59
|
-
optional :transport, String
|
|
59
|
+
optional :transport, String, nil?: true
|
|
60
60
|
|
|
61
61
|
# @!attribute user_agent
|
|
62
62
|
# The user agent of the SIP connection
|
|
63
63
|
#
|
|
64
64
|
# @return [String, nil]
|
|
65
|
-
optional :user_agent, String
|
|
65
|
+
optional :user_agent, String, nil?: true
|
|
66
66
|
|
|
67
67
|
# @!method initialize(ip_address: nil, last_registration: nil, port: nil, record_type: nil, sip_username: nil, status: nil, transport: nil, user_agent: nil)
|
|
68
|
-
# @param ip_address [String] The ip used during the SIP connection
|
|
68
|
+
# @param ip_address [String, nil] The ip used during the SIP connection
|
|
69
69
|
#
|
|
70
|
-
# @param last_registration [String] ISO 8601 formatted date indicating when the resource was last updated.
|
|
70
|
+
# @param last_registration [String, nil] ISO 8601 formatted date indicating when the resource was last updated.
|
|
71
71
|
#
|
|
72
|
-
# @param port [Integer] The port of the SIP connection
|
|
72
|
+
# @param port [Integer, nil] The port of the SIP connection
|
|
73
73
|
#
|
|
74
74
|
# @param record_type [String] Identifies the type of the resource.
|
|
75
75
|
#
|
|
76
|
-
# @param sip_username [String] The user name of the SIP connection
|
|
76
|
+
# @param sip_username [String, nil] The user name of the SIP connection
|
|
77
77
|
#
|
|
78
78
|
# @param status [Symbol, Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status] The current registration status of your SIP connection
|
|
79
79
|
#
|
|
80
|
-
# @param transport [String] The protocol of the SIP connection
|
|
80
|
+
# @param transport [String, nil] The protocol of the SIP connection
|
|
81
81
|
#
|
|
82
|
-
# @param user_agent [String] The user agent of the SIP connection
|
|
82
|
+
# @param user_agent [String, nil] The user agent of the SIP connection
|
|
83
83
|
|
|
84
84
|
# The current registration status of your SIP connection
|
|
85
85
|
#
|
data/lib/telnyx/models.rb
CHANGED
|
@@ -812,6 +812,8 @@ module Telnyx
|
|
|
812
812
|
|
|
813
813
|
ExternalConnectionUpdateParams = Telnyx::Models::ExternalConnectionUpdateParams
|
|
814
814
|
|
|
815
|
+
ExternalRequirements = Telnyx::Models::ExternalRequirements
|
|
816
|
+
|
|
815
817
|
ExternalVoiceIntegrationsPaginationMeta = Telnyx::Models::ExternalVoiceIntegrationsPaginationMeta
|
|
816
818
|
|
|
817
819
|
Fax = Telnyx::Models::Fax
|
|
@@ -1831,8 +1833,6 @@ module Telnyx
|
|
|
1831
1833
|
|
|
1832
1834
|
SiprecConnectorUpdateParams = Telnyx::Models::SiprecConnectorUpdateParams
|
|
1833
1835
|
|
|
1834
|
-
SipRegistrationStatusRetrieveParams = Telnyx::Models::SipRegistrationStatusRetrieveParams
|
|
1835
|
-
|
|
1836
1836
|
SoundModifications = Telnyx::Models::SoundModifications
|
|
1837
1837
|
|
|
1838
1838
|
SpeechToTextListProvidersParams = Telnyx::Models::SpeechToTextListProvidersParams
|
|
@@ -1818,7 +1818,7 @@ module Telnyx
|
|
|
1818
1818
|
# - `call.machine.premium.greeting.ended` if `answering_machine_detection=premium`
|
|
1819
1819
|
# was requested and a beep was detected
|
|
1820
1820
|
#
|
|
1821
|
-
# @overload transfer(call_control_id, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, client_state: nil, command_id: nil, custom_headers: nil, early_media: nil, from: nil, from_display_name: nil, media_encryption: nil, media_name: nil, mute_dtmf: nil, park_after_unbridge: nil, preferred_codecs: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, route_to_mobile: nil, send_digits_on_answer: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, target_leg_client_state: nil, time_limit_secs: nil, timeout_secs: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
|
|
1821
|
+
# @overload transfer(call_control_id, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, client_state: nil, command_id: nil, custom_headers: nil, diversion: nil, early_media: nil, from: nil, from_display_name: nil, media_encryption: nil, media_name: nil, mute_dtmf: nil, park_after_unbridge: nil, preferred_codecs: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, route_to_mobile: nil, send_digits_on_answer: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, target_leg_client_state: nil, time_limit_secs: nil, timeout_secs: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
|
|
1822
1822
|
#
|
|
1823
1823
|
# @param call_control_id [String] Unique identifier and token for controlling the call
|
|
1824
1824
|
#
|
|
@@ -1836,6 +1836,8 @@ module Telnyx
|
|
|
1836
1836
|
#
|
|
1837
1837
|
# @param custom_headers [Array<Telnyx::Models::CustomSipHeader>] Custom headers to be added to the SIP INVITE.
|
|
1838
1838
|
#
|
|
1839
|
+
# @param diversion [String] The number the inbound call being transferred was originally received on, in +E1
|
|
1840
|
+
#
|
|
1839
1841
|
# @param early_media [Boolean] If set to false, early media will not be passed to the originating leg.
|
|
1840
1842
|
#
|
|
1841
1843
|
# @param from [String] The `from` number to be used as the caller id presented to the destination (`to`
|