telnyx 5.173.0 → 5.174.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.
Files changed (118) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +0 -4
  5. data/lib/telnyx/lib/access_token.rb +141 -0
  6. data/lib/telnyx/lib/telephony_credentials.rb +87 -0
  7. data/lib/telnyx/lib.rb +2 -0
  8. data/lib/telnyx/models/ai/memory/namespaces/namespace_settings.rb +26 -0
  9. data/lib/telnyx/models/ai/memory/namespaces/namespace_settings_response.rb +3 -41
  10. data/lib/telnyx/models/ai/memory/namespaces/summary_settings.rb +33 -0
  11. data/lib/telnyx/models/ai/transcription_challenger.rb +148 -0
  12. data/lib/telnyx/models/ai/transcription_fallback_model.rb +78 -0
  13. data/lib/telnyx/models/ai/transcription_settings.rb +6 -219
  14. data/lib/telnyx/models/compute/funcs/func_log_export_config.rb +96 -0
  15. data/lib/telnyx/models/compute/funcs/func_log_export_config_response.rb +3 -89
  16. data/lib/telnyx/models/email_template_common.rb +5 -26
  17. data/lib/telnyx/models/email_template_create_params.rb +5 -26
  18. data/lib/telnyx/models/messaging_outbound_message_payload.rb +22 -1
  19. data/lib/telnyx/models/messaging_profile_features.rb +16 -1
  20. data/lib/telnyx/models/model_metadata.rb +10 -1
  21. data/lib/telnyx/models/outbound_message_payload.rb +22 -1
  22. data/lib/telnyx/models/phone_numbers/numbers_phone_numbers_job.rb +6 -50
  23. data/lib/telnyx/models/phone_numbers/phone_numbers_job.rb +6 -50
  24. data/lib/telnyx/models/phone_numbers/phone_numbers_job_pending_operation.rb +28 -0
  25. data/lib/telnyx/models/phone_numbers/phone_numbers_job_successful_operation.rb +28 -0
  26. data/lib/telnyx/models/update_email_template_request.rb +5 -26
  27. data/lib/telnyx/models/variable_schema_entry.rb +28 -0
  28. data/lib/telnyx/models/whatsapp/hosted_signup_create_response.rb +3 -83
  29. data/lib/telnyx/models/whatsapp/hosted_signup_retrieve_response.rb +3 -84
  30. data/lib/telnyx/models/whatsapp/phone_number_get_response.rb +3 -191
  31. data/lib/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rb +3 -192
  32. data/lib/telnyx/models/whatsapp/{hosted_signup_list_response.rb → whatsapp_hosted_signup.rb} +8 -6
  33. data/lib/telnyx/models/whatsapp/{phone_number_list_response.rb → whatsapp_phone_response.rb} +12 -12
  34. data/lib/telnyx/models.rb +2 -0
  35. data/lib/telnyx/resources/email_templates.rb +3 -3
  36. data/lib/telnyx/resources/portouts.rb +2 -1
  37. data/lib/telnyx/resources/whatsapp/business_accounts/phone_numbers.rb +2 -2
  38. data/lib/telnyx/resources/whatsapp/hosted_signups.rb +2 -2
  39. data/lib/telnyx/resources/whatsapp/phone_numbers.rb +2 -2
  40. data/lib/telnyx/version.rb +1 -1
  41. data/lib/telnyx.rb +10 -5
  42. data/rbi/telnyx/client.rbi +0 -3
  43. data/rbi/telnyx/lib/access_token.rbi +73 -0
  44. data/rbi/telnyx/lib/telephony_credentials.rbi +50 -0
  45. data/rbi/telnyx/models/ai/memory/namespaces/namespace_settings.rbi +58 -0
  46. data/rbi/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbi +4 -107
  47. data/rbi/telnyx/models/ai/memory/namespaces/summary_settings.rbi +51 -0
  48. data/rbi/telnyx/models/ai/transcription_challenger.rbi +318 -0
  49. data/rbi/telnyx/models/ai/transcription_fallback_model.rbi +171 -0
  50. data/rbi/telnyx/models/ai/transcription_settings.rbi +7 -531
  51. data/rbi/telnyx/models/compute/funcs/func_log_export_config.rbi +175 -0
  52. data/rbi/telnyx/models/compute/funcs/func_log_export_config_response.rbi +4 -176
  53. data/rbi/telnyx/models/email_template_common.rbi +3 -56
  54. data/rbi/telnyx/models/email_template_create_params.rbi +3 -59
  55. data/rbi/telnyx/models/messaging_outbound_message_payload.rbi +26 -0
  56. data/rbi/telnyx/models/messaging_profile_features.rbi +36 -5
  57. data/rbi/telnyx/models/model_metadata.rbi +13 -0
  58. data/rbi/telnyx/models/outbound_message_payload.rbi +26 -0
  59. data/rbi/telnyx/models/phone_numbers/numbers_phone_numbers_job.rbi +8 -96
  60. data/rbi/telnyx/models/phone_numbers/phone_numbers_job.rbi +8 -94
  61. data/rbi/telnyx/models/phone_numbers/phone_numbers_job_pending_operation.rbi +49 -0
  62. data/rbi/telnyx/models/phone_numbers/phone_numbers_job_successful_operation.rbi +49 -0
  63. data/rbi/telnyx/models/update_email_template_request.rbi +3 -59
  64. data/rbi/telnyx/models/variable_schema_entry.rbi +40 -0
  65. data/rbi/telnyx/models/whatsapp/hosted_signup_create_response.rbi +6 -173
  66. data/rbi/telnyx/models/whatsapp/hosted_signup_retrieve_response.rbi +6 -175
  67. data/rbi/telnyx/models/whatsapp/phone_number_get_response.rbi +4 -366
  68. data/rbi/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rbi +6 -368
  69. data/rbi/telnyx/models/whatsapp/{hosted_signup_list_response.rbi → whatsapp_hosted_signup.rbi} +11 -12
  70. data/rbi/telnyx/models/whatsapp/{phone_number_list_response.rbi → whatsapp_phone_response.rbi} +23 -23
  71. data/rbi/telnyx/models.rbi +2 -0
  72. data/rbi/telnyx/resources/email_templates.rbi +3 -18
  73. data/rbi/telnyx/resources/portouts.rbi +2 -1
  74. data/rbi/telnyx/resources/whatsapp/business_accounts/phone_numbers.rbi +1 -1
  75. data/rbi/telnyx/resources/whatsapp/hosted_signups.rbi +1 -1
  76. data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi +1 -1
  77. data/sig/telnyx/client.rbs +0 -2
  78. data/sig/telnyx/models/ai/memory/namespaces/namespace_settings.rbs +30 -0
  79. data/sig/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbs +4 -37
  80. data/sig/telnyx/models/ai/memory/namespaces/summary_settings.rbs +19 -0
  81. data/sig/telnyx/models/ai/transcription_challenger.rbs +98 -0
  82. data/sig/telnyx/models/ai/transcription_fallback_model.rbs +63 -0
  83. data/sig/telnyx/models/ai/transcription_settings.rbs +8 -159
  84. data/sig/telnyx/models/compute/funcs/func_log_export_config.rbs +96 -0
  85. data/sig/telnyx/models/compute/funcs/func_log_export_config_response.rbs +6 -95
  86. data/sig/telnyx/models/email_template_common.rbs +4 -18
  87. data/sig/telnyx/models/email_template_create_params.rbs +4 -18
  88. data/sig/telnyx/models/messaging_outbound_message_payload.rbs +10 -0
  89. data/sig/telnyx/models/messaging_profile_features.rbs +14 -3
  90. data/sig/telnyx/models/model_metadata.rbs +7 -0
  91. data/sig/telnyx/models/outbound_message_payload.rbs +10 -0
  92. data/sig/telnyx/models/phone_numbers/numbers_phone_numbers_job.rbs +12 -44
  93. data/sig/telnyx/models/phone_numbers/phone_numbers_job.rbs +12 -44
  94. data/sig/telnyx/models/phone_numbers/phone_numbers_job_pending_operation.rbs +24 -0
  95. data/sig/telnyx/models/phone_numbers/phone_numbers_job_successful_operation.rbs +24 -0
  96. data/sig/telnyx/models/update_email_template_request.rbs +4 -18
  97. data/sig/telnyx/models/variable_schema_entry.rbs +17 -0
  98. data/sig/telnyx/models/whatsapp/hosted_signup_create_response.rbs +6 -90
  99. data/sig/telnyx/models/whatsapp/hosted_signup_retrieve_response.rbs +6 -90
  100. data/sig/telnyx/models/whatsapp/phone_number_get_response.rbs +6 -185
  101. data/sig/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rbs +4 -189
  102. data/sig/telnyx/models/whatsapp/{hosted_signup_list_response.rbs → whatsapp_hosted_signup.rbs} +11 -9
  103. data/sig/telnyx/models/whatsapp/{phone_number_list_response.rbs → whatsapp_phone_response.rbs} +13 -11
  104. data/sig/telnyx/models.rbs +2 -0
  105. data/sig/telnyx/resources/email_templates.rbs +3 -3
  106. data/sig/telnyx/resources/whatsapp/business_accounts/phone_numbers.rbs +1 -1
  107. data/sig/telnyx/resources/whatsapp/hosted_signups.rbs +1 -1
  108. data/sig/telnyx/resources/whatsapp/phone_numbers.rbs +1 -1
  109. metadata +36 -17
  110. data/lib/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rb +0 -198
  111. data/lib/telnyx/resources/tts_integrations/actions.rb +0 -16
  112. data/lib/telnyx/resources/tts_integrations.rb +0 -18
  113. data/rbi/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rbi +0 -358
  114. data/rbi/telnyx/resources/tts_integrations/actions.rbi +0 -14
  115. data/rbi/telnyx/resources/tts_integrations.rbi +0 -15
  116. data/sig/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rbs +0 -186
  117. data/sig/telnyx/resources/tts_integrations/actions.rbs +0 -9
  118. data/sig/telnyx/resources/tts_integrations.rbs +0 -9
@@ -7,9 +7,8 @@ module Telnyx
7
7
  class PhoneNumberGetResponse < Telnyx::Internal::Type::BaseModel
8
8
  # @!attribute data
9
9
  #
10
- # @return [Array<Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data>, nil]
11
- optional :data,
12
- -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data] }
10
+ # @return [Array<Telnyx::Models::Whatsapp::WhatsappPhoneResponse>, nil]
11
+ optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Whatsapp::WhatsappPhoneResponse] }
13
12
 
14
13
  # @!attribute meta
15
14
  #
@@ -17,195 +16,8 @@ module Telnyx
17
16
  optional :meta, -> { Telnyx::MessagingPaginationMeta }
18
17
 
19
18
  # @!method initialize(data: nil, meta: nil)
20
- # @param data [Array<Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data>]
19
+ # @param data [Array<Telnyx::Models::Whatsapp::WhatsappPhoneResponse>]
21
20
  # @param meta [Telnyx::Models::MessagingPaginationMeta]
22
-
23
- class Data < Telnyx::Internal::Type::BaseModel
24
- # @!attribute calling_enabled
25
- #
26
- # @return [Boolean, nil]
27
- optional :calling_enabled, Telnyx::Internal::Type::Boolean
28
-
29
- # @!attribute coexistence_state
30
- # Current lifecycle state for a coexistence number. This is null for a standard
31
- # Cloud API number.
32
- #
33
- # @return [Symbol, Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data::CoexistenceState, nil]
34
- optional :coexistence_state,
35
- enum: -> { Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data::CoexistenceState },
36
- nil?: true
37
-
38
- # @!attribute created_at
39
- #
40
- # @return [Time, nil]
41
- optional :created_at, Time
42
-
43
- # @!attribute display_name
44
- #
45
- # @return [String, nil]
46
- optional :display_name, String
47
-
48
- # @!attribute enabled
49
- #
50
- # @return [Boolean, nil]
51
- optional :enabled, Telnyx::Internal::Type::Boolean
52
-
53
- # @!attribute is_on_biz_app
54
- # Indicates whether the number is connected to both the WhatsApp Business app and
55
- # Cloud API through WhatsApp Coexistence.
56
- #
57
- # @return [Boolean, nil]
58
- optional :is_on_biz_app, Telnyx::Internal::Type::Boolean
59
-
60
- # @!attribute phone_number
61
- # Phone number in E164 format
62
- #
63
- # @return [String, nil]
64
- optional :phone_number, String
65
-
66
- # @!attribute phone_number_id
67
- # Whatsapp phone number ID
68
- #
69
- # @return [String, nil]
70
- optional :phone_number_id, String
71
-
72
- # @!attribute quality_rating
73
- # Whatsapp quality rating
74
- #
75
- # @return [String, nil]
76
- optional :quality_rating, String
77
-
78
- # @!attribute record_type
79
- #
80
- # @return [String, nil]
81
- optional :record_type, String
82
-
83
- # @!attribute status
84
- #
85
- # @return [String, nil]
86
- optional :status, String
87
-
88
- # @!attribute sync_deadline
89
- # Deadline for initiating the current coexistence synchronization cycle. This is
90
- # null when no deadline applies.
91
- #
92
- # @return [Time, nil]
93
- optional :sync_deadline, Time, nil?: true
94
-
95
- # @!attribute sync_progress
96
- # Synchronization progress. This object is returned only while a coexistence
97
- # number is synchronizing.
98
- #
99
- # @return [Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data::SyncProgress, nil]
100
- optional :sync_progress,
101
- -> { Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data::SyncProgress },
102
- nil?: true
103
-
104
- # @!attribute user_id
105
- # User ID
106
- #
107
- # @return [String, nil]
108
- optional :user_id, String
109
-
110
- # @!attribute waba_id
111
- # WABA ID of Whatsapp business account
112
- #
113
- # @return [String, nil]
114
- optional :waba_id, String
115
-
116
- # @!method initialize(calling_enabled: nil, coexistence_state: nil, created_at: nil, display_name: nil, enabled: nil, is_on_biz_app: nil, phone_number: nil, phone_number_id: nil, quality_rating: nil, record_type: nil, status: nil, sync_deadline: nil, sync_progress: nil, user_id: nil, waba_id: nil)
117
- # Some parameter documentations has been truncated, see
118
- # {Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data} for more details.
119
- #
120
- # @param calling_enabled [Boolean]
121
- #
122
- # @param coexistence_state [Symbol, Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data::CoexistenceState, nil] Current lifecycle state for a coexistence number. This is null for a standard Cl
123
- #
124
- # @param created_at [Time]
125
- #
126
- # @param display_name [String]
127
- #
128
- # @param enabled [Boolean]
129
- #
130
- # @param is_on_biz_app [Boolean] Indicates whether the number is connected to both the WhatsApp Business app and
131
- #
132
- # @param phone_number [String] Phone number in E164 format
133
- #
134
- # @param phone_number_id [String] Whatsapp phone number ID
135
- #
136
- # @param quality_rating [String] Whatsapp quality rating
137
- #
138
- # @param record_type [String]
139
- #
140
- # @param status [String]
141
- #
142
- # @param sync_deadline [Time, nil] Deadline for initiating the current coexistence synchronization cycle. This is n
143
- #
144
- # @param sync_progress [Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data::SyncProgress, nil] Synchronization progress. This object is returned only while a coexistence numbe
145
- #
146
- # @param user_id [String] User ID
147
- #
148
- # @param waba_id [String] WABA ID of Whatsapp business account
149
-
150
- # Current lifecycle state for a coexistence number. This is null for a standard
151
- # Cloud API number.
152
- #
153
- # @see Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data#coexistence_state
154
- module CoexistenceState
155
- extend Telnyx::Internal::Type::Enum
156
-
157
- PENDING_ONBOARDING = :pending_onboarding
158
- SYNC_PENDING = :sync_pending
159
- SYNCING = :syncing
160
- SYNC_COMPLETE = :sync_complete
161
- ACTIVE = :active
162
- HISTORY_DECLINED = :history_declined
163
- SYNC_DEADLINE_EXPIRED = :sync_deadline_expired
164
- OFFBOARDED = :offboarded
165
- DISCONNECTED = :disconnected
166
-
167
- # @!method self.values
168
- # @return [Array<Symbol>]
169
- end
170
-
171
- # @see Telnyx::Models::Whatsapp::PhoneNumberGetResponse::Data#sync_progress
172
- class SyncProgress < Telnyx::Internal::Type::BaseModel
173
- # @!attribute contacts_status
174
- #
175
- # @return [String, nil]
176
- optional :contacts_status, String
177
-
178
- # @!attribute history_chunk_order
179
- #
180
- # @return [Integer, nil]
181
- optional :history_chunk_order, Integer, nil?: true
182
-
183
- # @!attribute history_phase
184
- #
185
- # @return [Integer, nil]
186
- optional :history_phase, Integer, nil?: true
187
-
188
- # @!attribute history_progress
189
- #
190
- # @return [Integer, nil]
191
- optional :history_progress, Integer, nil?: true
192
-
193
- # @!attribute history_status
194
- #
195
- # @return [String, nil]
196
- optional :history_status, String
197
-
198
- # @!method initialize(contacts_status: nil, history_chunk_order: nil, history_phase: nil, history_progress: nil, history_status: nil)
199
- # Synchronization progress. This object is returned only while a coexistence
200
- # number is synchronizing.
201
- #
202
- # @param contacts_status [String]
203
- # @param history_chunk_order [Integer, nil]
204
- # @param history_phase [Integer, nil]
205
- # @param history_progress [Integer, nil]
206
- # @param history_status [String]
207
- end
208
- end
209
21
  end
210
22
  end
211
23
  end
@@ -7,200 +7,11 @@ module Telnyx
7
7
  class PhoneNumberRetrievePhoneNumberResponse < Telnyx::Internal::Type::BaseModel
8
8
  # @!attribute data
9
9
  #
10
- # @return [Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse::Data]
11
- required :data, -> { Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse::Data }
10
+ # @return [Telnyx::Models::Whatsapp::WhatsappPhoneResponse]
11
+ required :data, -> { Telnyx::Whatsapp::WhatsappPhoneResponse }
12
12
 
13
13
  # @!method initialize(data:)
14
- # @param data [Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse::Data]
15
-
16
- # @see Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse#data
17
- class Data < Telnyx::Internal::Type::BaseModel
18
- # @!attribute calling_enabled
19
- #
20
- # @return [Boolean, nil]
21
- optional :calling_enabled, Telnyx::Internal::Type::Boolean
22
-
23
- # @!attribute coexistence_state
24
- # Current lifecycle state for a coexistence number. This is null for a standard
25
- # Cloud API number.
26
- #
27
- # @return [Symbol, Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse::Data::CoexistenceState, nil]
28
- optional :coexistence_state,
29
- enum: -> { Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse::Data::CoexistenceState },
30
- nil?: true
31
-
32
- # @!attribute created_at
33
- #
34
- # @return [Time, nil]
35
- optional :created_at, Time
36
-
37
- # @!attribute display_name
38
- #
39
- # @return [String, nil]
40
- optional :display_name, String
41
-
42
- # @!attribute enabled
43
- #
44
- # @return [Boolean, nil]
45
- optional :enabled, Telnyx::Internal::Type::Boolean
46
-
47
- # @!attribute is_on_biz_app
48
- # Indicates whether the number is connected to both the WhatsApp Business app and
49
- # Cloud API through WhatsApp Coexistence.
50
- #
51
- # @return [Boolean, nil]
52
- optional :is_on_biz_app, Telnyx::Internal::Type::Boolean
53
-
54
- # @!attribute phone_number
55
- # Phone number in E164 format
56
- #
57
- # @return [String, nil]
58
- optional :phone_number, String
59
-
60
- # @!attribute phone_number_id
61
- # Whatsapp phone number ID
62
- #
63
- # @return [String, nil]
64
- optional :phone_number_id, String
65
-
66
- # @!attribute quality_rating
67
- # Whatsapp quality rating
68
- #
69
- # @return [String, nil]
70
- optional :quality_rating, String
71
-
72
- # @!attribute record_type
73
- #
74
- # @return [String, nil]
75
- optional :record_type, String
76
-
77
- # @!attribute status
78
- #
79
- # @return [String, nil]
80
- optional :status, String
81
-
82
- # @!attribute sync_deadline
83
- # Deadline for initiating the current coexistence synchronization cycle. This is
84
- # null when no deadline applies.
85
- #
86
- # @return [Time, nil]
87
- optional :sync_deadline, Time, nil?: true
88
-
89
- # @!attribute sync_progress
90
- # Synchronization progress. This object is returned only while a coexistence
91
- # number is synchronizing.
92
- #
93
- # @return [Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse::Data::SyncProgress, nil]
94
- optional :sync_progress,
95
- -> { Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse::Data::SyncProgress },
96
- nil?: true
97
-
98
- # @!attribute user_id
99
- # User ID
100
- #
101
- # @return [String, nil]
102
- optional :user_id, String
103
-
104
- # @!attribute waba_id
105
- # WABA ID of Whatsapp business account
106
- #
107
- # @return [String, nil]
108
- optional :waba_id, String
109
-
110
- # @!method initialize(calling_enabled: nil, coexistence_state: nil, created_at: nil, display_name: nil, enabled: nil, is_on_biz_app: nil, phone_number: nil, phone_number_id: nil, quality_rating: nil, record_type: nil, status: nil, sync_deadline: nil, sync_progress: nil, user_id: nil, waba_id: nil)
111
- # Some parameter documentations has been truncated, see
112
- # {Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse::Data} for
113
- # more details.
114
- #
115
- # @param calling_enabled [Boolean]
116
- #
117
- # @param coexistence_state [Symbol, Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse::Data::CoexistenceState, nil] Current lifecycle state for a coexistence number. This is null for a standard Cl
118
- #
119
- # @param created_at [Time]
120
- #
121
- # @param display_name [String]
122
- #
123
- # @param enabled [Boolean]
124
- #
125
- # @param is_on_biz_app [Boolean] Indicates whether the number is connected to both the WhatsApp Business app and
126
- #
127
- # @param phone_number [String] Phone number in E164 format
128
- #
129
- # @param phone_number_id [String] Whatsapp phone number ID
130
- #
131
- # @param quality_rating [String] Whatsapp quality rating
132
- #
133
- # @param record_type [String]
134
- #
135
- # @param status [String]
136
- #
137
- # @param sync_deadline [Time, nil] Deadline for initiating the current coexistence synchronization cycle. This is n
138
- #
139
- # @param sync_progress [Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse::Data::SyncProgress, nil] Synchronization progress. This object is returned only while a coexistence numbe
140
- #
141
- # @param user_id [String] User ID
142
- #
143
- # @param waba_id [String] WABA ID of Whatsapp business account
144
-
145
- # Current lifecycle state for a coexistence number. This is null for a standard
146
- # Cloud API number.
147
- #
148
- # @see Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse::Data#coexistence_state
149
- module CoexistenceState
150
- extend Telnyx::Internal::Type::Enum
151
-
152
- PENDING_ONBOARDING = :pending_onboarding
153
- SYNC_PENDING = :sync_pending
154
- SYNCING = :syncing
155
- SYNC_COMPLETE = :sync_complete
156
- ACTIVE = :active
157
- HISTORY_DECLINED = :history_declined
158
- SYNC_DEADLINE_EXPIRED = :sync_deadline_expired
159
- OFFBOARDED = :offboarded
160
- DISCONNECTED = :disconnected
161
-
162
- # @!method self.values
163
- # @return [Array<Symbol>]
164
- end
165
-
166
- # @see Telnyx::Models::Whatsapp::PhoneNumberRetrievePhoneNumberResponse::Data#sync_progress
167
- class SyncProgress < Telnyx::Internal::Type::BaseModel
168
- # @!attribute contacts_status
169
- #
170
- # @return [String, nil]
171
- optional :contacts_status, String
172
-
173
- # @!attribute history_chunk_order
174
- #
175
- # @return [Integer, nil]
176
- optional :history_chunk_order, Integer, nil?: true
177
-
178
- # @!attribute history_phase
179
- #
180
- # @return [Integer, nil]
181
- optional :history_phase, Integer, nil?: true
182
-
183
- # @!attribute history_progress
184
- #
185
- # @return [Integer, nil]
186
- optional :history_progress, Integer, nil?: true
187
-
188
- # @!attribute history_status
189
- #
190
- # @return [String, nil]
191
- optional :history_status, String
192
-
193
- # @!method initialize(contacts_status: nil, history_chunk_order: nil, history_phase: nil, history_progress: nil, history_status: nil)
194
- # Synchronization progress. This object is returned only while a coexistence
195
- # number is synchronizing.
196
- #
197
- # @param contacts_status [String]
198
- # @param history_chunk_order [Integer, nil]
199
- # @param history_phase [Integer, nil]
200
- # @param history_progress [Integer, nil]
201
- # @param history_status [String]
202
- end
203
- end
14
+ # @param data [Telnyx::Models::Whatsapp::WhatsappPhoneResponse]
204
15
  end
205
16
  end
206
17
  end
@@ -4,7 +4,7 @@ module Telnyx
4
4
  module Models
5
5
  module Whatsapp
6
6
  # @see Telnyx::Resources::Whatsapp::HostedSignups#list
7
- class HostedSignupListResponse < Telnyx::Internal::Type::BaseModel
7
+ class WhatsappHostedSignup < Telnyx::Internal::Type::BaseModel
8
8
  # @!attribute id
9
9
  # Hosted signup ID
10
10
  #
@@ -36,8 +36,8 @@ module Telnyx
36
36
 
37
37
  # @!attribute record_type
38
38
  #
39
- # @return [Symbol, Telnyx::Models::Whatsapp::HostedSignupListResponse::RecordType, nil]
40
- optional :record_type, enum: -> { Telnyx::Models::Whatsapp::HostedSignupListResponse::RecordType }
39
+ # @return [Symbol, Telnyx::Models::Whatsapp::WhatsappHostedSignup::RecordType, nil]
40
+ optional :record_type, enum: -> { Telnyx::Whatsapp::WhatsappHostedSignup::RecordType }
41
41
 
42
42
  # @!attribute solution_id
43
43
  # Meta Partner Solution ID linked to the app. Returned only when creating a hosted
@@ -54,7 +54,7 @@ module Telnyx
54
54
 
55
55
  # @!method initialize(id: nil, app_id: nil, created_at: nil, expires_at: nil, jwt: nil, record_type: nil, solution_id: nil, url: nil)
56
56
  # Some parameter documentations has been truncated, see
57
- # {Telnyx::Models::Whatsapp::HostedSignupListResponse} for more details.
57
+ # {Telnyx::Models::Whatsapp::WhatsappHostedSignup} for more details.
58
58
  #
59
59
  # @param id [String] Hosted signup ID
60
60
  #
@@ -66,13 +66,13 @@ module Telnyx
66
66
  #
67
67
  # @param jwt [String] Signed token embedded in `url`
68
68
  #
69
- # @param record_type [Symbol, Telnyx::Models::Whatsapp::HostedSignupListResponse::RecordType]
69
+ # @param record_type [Symbol, Telnyx::Models::Whatsapp::WhatsappHostedSignup::RecordType]
70
70
  #
71
71
  # @param solution_id [String] Meta Partner Solution ID linked to the app. Returned only when creating a hosted
72
72
  #
73
73
  # @param url [String] Hosted onboarding URL to share with the end customer
74
74
 
75
- # @see Telnyx::Models::Whatsapp::HostedSignupListResponse#record_type
75
+ # @see Telnyx::Models::Whatsapp::WhatsappHostedSignup#record_type
76
76
  module RecordType
77
77
  extend Telnyx::Internal::Type::Enum
78
78
 
@@ -83,5 +83,7 @@ module Telnyx
83
83
  end
84
84
  end
85
85
  end
86
+
87
+ WhatsappHostedSignup = Whatsapp::WhatsappHostedSignup
86
88
  end
87
89
  end
@@ -4,7 +4,7 @@ module Telnyx
4
4
  module Models
5
5
  module Whatsapp
6
6
  # @see Telnyx::Resources::Whatsapp::PhoneNumbers#list
7
- class PhoneNumberListResponse < Telnyx::Internal::Type::BaseModel
7
+ class WhatsappPhoneResponse < Telnyx::Internal::Type::BaseModel
8
8
  # @!attribute calling_enabled
9
9
  #
10
10
  # @return [Boolean, nil]
@@ -14,9 +14,9 @@ module Telnyx
14
14
  # Current lifecycle state for a coexistence number. This is null for a standard
15
15
  # Cloud API number.
16
16
  #
17
- # @return [Symbol, Telnyx::Models::Whatsapp::PhoneNumberListResponse::CoexistenceState, nil]
17
+ # @return [Symbol, Telnyx::Models::Whatsapp::WhatsappPhoneResponse::CoexistenceState, nil]
18
18
  optional :coexistence_state,
19
- enum: -> { Telnyx::Models::Whatsapp::PhoneNumberListResponse::CoexistenceState },
19
+ enum: -> { Telnyx::Whatsapp::WhatsappPhoneResponse::CoexistenceState },
20
20
  nil?: true
21
21
 
22
22
  # @!attribute created_at
@@ -80,10 +80,8 @@ module Telnyx
80
80
  # Synchronization progress. This object is returned only while a coexistence
81
81
  # number is synchronizing.
82
82
  #
83
- # @return [Telnyx::Models::Whatsapp::PhoneNumberListResponse::SyncProgress, nil]
84
- optional :sync_progress,
85
- -> { Telnyx::Models::Whatsapp::PhoneNumberListResponse::SyncProgress },
86
- nil?: true
83
+ # @return [Telnyx::Models::Whatsapp::WhatsappPhoneResponse::SyncProgress, nil]
84
+ optional :sync_progress, -> { Telnyx::Whatsapp::WhatsappPhoneResponse::SyncProgress }, nil?: true
87
85
 
88
86
  # @!attribute user_id
89
87
  # User ID
@@ -99,11 +97,11 @@ module Telnyx
99
97
 
100
98
  # @!method initialize(calling_enabled: nil, coexistence_state: nil, created_at: nil, display_name: nil, enabled: nil, is_on_biz_app: nil, phone_number: nil, phone_number_id: nil, quality_rating: nil, record_type: nil, status: nil, sync_deadline: nil, sync_progress: nil, user_id: nil, waba_id: nil)
101
99
  # Some parameter documentations has been truncated, see
102
- # {Telnyx::Models::Whatsapp::PhoneNumberListResponse} for more details.
100
+ # {Telnyx::Models::Whatsapp::WhatsappPhoneResponse} for more details.
103
101
  #
104
102
  # @param calling_enabled [Boolean]
105
103
  #
106
- # @param coexistence_state [Symbol, Telnyx::Models::Whatsapp::PhoneNumberListResponse::CoexistenceState, nil] Current lifecycle state for a coexistence number. This is null for a standard Cl
104
+ # @param coexistence_state [Symbol, Telnyx::Models::Whatsapp::WhatsappPhoneResponse::CoexistenceState, nil] Current lifecycle state for a coexistence number. This is null for a standard Cl
107
105
  #
108
106
  # @param created_at [Time]
109
107
  #
@@ -125,7 +123,7 @@ module Telnyx
125
123
  #
126
124
  # @param sync_deadline [Time, nil] Deadline for initiating the current coexistence synchronization cycle. This is n
127
125
  #
128
- # @param sync_progress [Telnyx::Models::Whatsapp::PhoneNumberListResponse::SyncProgress, nil] Synchronization progress. This object is returned only while a coexistence numbe
126
+ # @param sync_progress [Telnyx::Models::Whatsapp::WhatsappPhoneResponse::SyncProgress, nil] Synchronization progress. This object is returned only while a coexistence numbe
129
127
  #
130
128
  # @param user_id [String] User ID
131
129
  #
@@ -134,7 +132,7 @@ module Telnyx
134
132
  # Current lifecycle state for a coexistence number. This is null for a standard
135
133
  # Cloud API number.
136
134
  #
137
- # @see Telnyx::Models::Whatsapp::PhoneNumberListResponse#coexistence_state
135
+ # @see Telnyx::Models::Whatsapp::WhatsappPhoneResponse#coexistence_state
138
136
  module CoexistenceState
139
137
  extend Telnyx::Internal::Type::Enum
140
138
 
@@ -152,7 +150,7 @@ module Telnyx
152
150
  # @return [Array<Symbol>]
153
151
  end
154
152
 
155
- # @see Telnyx::Models::Whatsapp::PhoneNumberListResponse#sync_progress
153
+ # @see Telnyx::Models::Whatsapp::WhatsappPhoneResponse#sync_progress
156
154
  class SyncProgress < Telnyx::Internal::Type::BaseModel
157
155
  # @!attribute contacts_status
158
156
  #
@@ -191,5 +189,7 @@ module Telnyx
191
189
  end
192
190
  end
193
191
  end
192
+
193
+ WhatsappPhoneResponse = Whatsapp::WhatsappPhoneResponse
194
194
  end
195
195
  end
data/lib/telnyx/models.rb CHANGED
@@ -2171,6 +2171,8 @@ module Telnyx
2171
2171
 
2172
2172
  UserTagListParams = Telnyx::Models::UserTagListParams
2173
2173
 
2174
+ VariableSchemaEntry = Telnyx::Models::VariableSchemaEntry
2175
+
2174
2176
  Verification = Telnyx::Models::Verification
2175
2177
 
2176
2178
  VerificationRetrieveParams = Telnyx::Models::VerificationRetrieveParams
@@ -23,7 +23,7 @@ module Telnyx
23
23
  #
24
24
  # @param text_body [String, nil] Body param: Liquid template text body.
25
25
  #
26
- # @param variable_schema [Hash{Symbol=>Telnyx::Models::EmailTemplateCreateParams::VariableSchema}, nil] Body param: Structured variable requirements. Required variables cannot define d
26
+ # @param variable_schema [Hash{Symbol=>Telnyx::Models::VariableSchemaEntry}, nil] Body param: Structured variable requirements. Required variables cannot define d
27
27
  #
28
28
  # @param variables [Array<String>, nil] Body param: Persisted variable names. In `automatic` mode a non-null array is re
29
29
  #
@@ -92,7 +92,7 @@ module Telnyx
92
92
  #
93
93
  # @param text_body [String, nil] Liquid template text body.
94
94
  #
95
- # @param variable_schema [Hash{Symbol=>Telnyx::Models::UpdateEmailTemplateRequest::VariableSchema}, nil] Structured variable requirements. Required variables cannot define defaults; inv
95
+ # @param variable_schema [Hash{Symbol=>Telnyx::Models::VariableSchemaEntry}, nil] Structured variable requirements. Required variables cannot define defaults; inv
96
96
  #
97
97
  # @param variables [Array<String>, nil] Persisted variable names. In `automatic` mode a non-null array is rejected; in `
98
98
  #
@@ -237,7 +237,7 @@ module Telnyx
237
237
  #
238
238
  # @param text_body [String, nil] Liquid template text body.
239
239
  #
240
- # @param variable_schema [Hash{Symbol=>Telnyx::Models::UpdateEmailTemplateRequest::VariableSchema}, nil] Structured variable requirements. Required variables cannot define defaults; inv
240
+ # @param variable_schema [Hash{Symbol=>Telnyx::Models::VariableSchemaEntry}, nil] Structured variable requirements. Required variables cannot define defaults; inv
241
241
  #
242
242
  # @param variables [Array<String>, nil] Persisted variable names. In `automatic` mode a non-null array is rejected; in `
243
243
  #
@@ -43,7 +43,8 @@ module Telnyx
43
43
  # Some parameter documentations has been truncated, see
44
44
  # {Telnyx::Models::PortoutListParams} for more details.
45
45
  #
46
- # Returns the portout requests according to filters
46
+ # Returns the portout requests according to filters. Carrier Port Out API
47
+ # available. Please contact porting@telnyx.com.
47
48
  #
48
49
  # @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
49
50
  #
@@ -17,7 +17,7 @@ module Telnyx
17
17
  #
18
18
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
19
19
  #
20
- # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse>]
20
+ # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Whatsapp::WhatsappPhoneResponse>]
21
21
  #
22
22
  # @see Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListParams
23
23
  def list(id, params = {})
@@ -28,7 +28,7 @@ module Telnyx
28
28
  path: ["v2/whatsapp/business_accounts/%1$s/phone_numbers", id],
29
29
  query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
30
30
  page: Telnyx::Internal::DefaultFlatPagination,
31
- model: Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse,
31
+ model: Telnyx::Whatsapp::WhatsappPhoneResponse,
32
32
  options: options
33
33
  )
34
34
  end
@@ -65,7 +65,7 @@ module Telnyx
65
65
  # @param page_size [Integer]
66
66
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
67
67
  #
68
- # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Whatsapp::HostedSignupListResponse>]
68
+ # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Whatsapp::WhatsappHostedSignup>]
69
69
  #
70
70
  # @see Telnyx::Models::Whatsapp::HostedSignupListParams
71
71
  def list(params = {})
@@ -76,7 +76,7 @@ module Telnyx
76
76
  path: "whatsapp/hosted_signups",
77
77
  query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
78
78
  page: Telnyx::Internal::DefaultFlatPagination,
79
- model: Telnyx::Models::Whatsapp::HostedSignupListResponse,
79
+ model: Telnyx::Whatsapp::WhatsappHostedSignup,
80
80
  options: options
81
81
  )
82
82
  end
@@ -29,7 +29,7 @@ module Telnyx
29
29
  # @param page_size [Integer]
30
30
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
31
31
  #
32
- # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Whatsapp::PhoneNumberListResponse>]
32
+ # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Whatsapp::WhatsappPhoneResponse>]
33
33
  #
34
34
  # @see Telnyx::Models::Whatsapp::PhoneNumberListParams
35
35
  def list(params = {})
@@ -40,7 +40,7 @@ module Telnyx
40
40
  path: "v2/whatsapp/phone_numbers",
41
41
  query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
42
42
  page: Telnyx::Internal::DefaultFlatPagination,
43
- model: Telnyx::Models::Whatsapp::PhoneNumberListResponse,
43
+ model: Telnyx::Whatsapp::WhatsappPhoneResponse,
44
44
  options: options
45
45
  )
46
46
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Telnyx
4
- VERSION = "5.173.0"
4
+ VERSION = "5.174.0"
5
5
  end