telnyx 5.67.0 → 5.68.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +39 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/internal/util.rb +1 -2
  5. data/lib/telnyx/models/ai/voice_settings.rb +1 -1
  6. data/lib/telnyx/models/billing_address.rb +56 -0
  7. data/lib/telnyx/models/billing_contact.rb +40 -0
  8. data/lib/telnyx/models/enterprise_create_params.rb +12 -196
  9. data/lib/telnyx/models/enterprise_create_response.rb +3 -437
  10. data/lib/telnyx/models/enterprise_public.rb +249 -0
  11. data/lib/telnyx/models/enterprise_retrieve_response.rb +3 -439
  12. data/lib/telnyx/models/enterprise_update_params.rb +12 -196
  13. data/lib/telnyx/models/enterprise_update_response.rb +3 -437
  14. data/lib/telnyx/models/enterprises/enterprise_reputation_public.rb +100 -0
  15. data/lib/telnyx/models/enterprises/reputation/number_create_response.rb +3 -39
  16. data/lib/telnyx/models/enterprises/reputation/number_retrieve_response.rb +3 -148
  17. data/lib/telnyx/models/enterprises/reputation_create_response.rb +3 -96
  18. data/lib/telnyx/models/enterprises/reputation_list_response.rb +3 -96
  19. data/lib/telnyx/models/enterprises/reputation_update_frequency_response.rb +3 -97
  20. data/lib/telnyx/models/meta_info.rb +40 -0
  21. data/lib/telnyx/models/organization_contact.rb +51 -0
  22. data/lib/telnyx/models/physical_address.rb +56 -0
  23. data/lib/telnyx/models/reputation/number_retrieve_response.rb +3 -148
  24. data/lib/telnyx/models/reputation_data.rb +80 -0
  25. data/lib/telnyx/models/reputation_phone_number_with_reputation_data.rb +56 -0
  26. data/lib/telnyx/models.rb +16 -0
  27. data/lib/telnyx/resources/enterprises/reputation/numbers.rb +2 -2
  28. data/lib/telnyx/resources/enterprises.rb +10 -10
  29. data/lib/telnyx/resources/reputation/numbers.rb +2 -2
  30. data/lib/telnyx/version.rb +1 -1
  31. data/lib/telnyx.rb +9 -3
  32. data/rbi/telnyx/models/ai/voice_settings.rbi +2 -2
  33. data/rbi/telnyx/models/billing_address.rbi +77 -0
  34. data/rbi/telnyx/models/billing_contact.rbi +61 -0
  35. data/rbi/telnyx/models/enterprise_create_params.rbi +16 -316
  36. data/rbi/telnyx/models/enterprise_create_response.rbi +4 -814
  37. data/rbi/telnyx/models/enterprise_public.rbi +436 -0
  38. data/rbi/telnyx/models/enterprise_retrieve_response.rbi +4 -816
  39. data/rbi/telnyx/models/enterprise_update_params.rbi +16 -320
  40. data/rbi/telnyx/models/enterprise_update_response.rbi +4 -814
  41. data/rbi/telnyx/models/enterprises/enterprise_reputation_public.rbi +233 -0
  42. data/rbi/telnyx/models/enterprises/reputation/number_create_response.rbi +4 -88
  43. data/rbi/telnyx/models/enterprises/reputation/number_retrieve_response.rbi +4 -292
  44. data/rbi/telnyx/models/enterprises/reputation_create_response.rbi +4 -236
  45. data/rbi/telnyx/models/enterprises/reputation_list_response.rbi +4 -232
  46. data/rbi/telnyx/models/enterprises/reputation_update_frequency_response.rbi +4 -237
  47. data/rbi/telnyx/models/meta_info.rbi +71 -0
  48. data/rbi/telnyx/models/organization_contact.rbi +71 -0
  49. data/rbi/telnyx/models/physical_address.rbi +77 -0
  50. data/rbi/telnyx/models/reputation/number_retrieve_response.rbi +4 -287
  51. data/rbi/telnyx/models/reputation_data.rbi +107 -0
  52. data/rbi/telnyx/models/reputation_phone_number_with_reputation_data.rbi +98 -0
  53. data/rbi/telnyx/models.rbi +17 -0
  54. data/rbi/telnyx/resources/enterprises/reputation/numbers.rbi +1 -1
  55. data/rbi/telnyx/resources/enterprises.rbi +9 -19
  56. data/rbi/telnyx/resources/reputation/numbers.rbi +1 -1
  57. data/sig/telnyx/models/billing_address.rbs +45 -0
  58. data/sig/telnyx/models/billing_contact.rbs +35 -0
  59. data/sig/telnyx/models/enterprise_create_params.rbs +16 -169
  60. data/sig/telnyx/models/enterprise_create_response.rbs +5 -382
  61. data/sig/telnyx/models/enterprise_public.rbs +218 -0
  62. data/sig/telnyx/models/enterprise_retrieve_response.rbs +5 -382
  63. data/sig/telnyx/models/enterprise_update_params.rbs +22 -179
  64. data/sig/telnyx/models/enterprise_update_response.rbs +5 -382
  65. data/sig/telnyx/models/enterprises/enterprise_reputation_public.rbs +97 -0
  66. data/sig/telnyx/models/enterprises/reputation/number_create_response.rbs +5 -47
  67. data/sig/telnyx/models/enterprises/reputation/number_retrieve_response.rbs +6 -133
  68. data/sig/telnyx/models/enterprises/reputation_create_response.rbs +6 -96
  69. data/sig/telnyx/models/enterprises/reputation_list_response.rbs +6 -96
  70. data/sig/telnyx/models/enterprises/reputation_update_frequency_response.rbs +6 -98
  71. data/sig/telnyx/models/meta_info.rbs +43 -0
  72. data/sig/telnyx/models/organization_contact.rbs +40 -0
  73. data/sig/telnyx/models/physical_address.rbs +45 -0
  74. data/sig/telnyx/models/reputation/number_retrieve_response.rbs +6 -131
  75. data/sig/telnyx/models/reputation_data.rbs +62 -0
  76. data/sig/telnyx/models/reputation_phone_number_with_reputation_data.rbs +57 -0
  77. data/sig/telnyx/models.rbs +16 -0
  78. data/sig/telnyx/resources/enterprises/reputation/numbers.rbs +1 -1
  79. data/sig/telnyx/resources/enterprises.rbs +9 -9
  80. data/sig/telnyx/resources/reputation/numbers.rbs +1 -1
  81. metadata +29 -11
  82. data/lib/telnyx/models/enterprise_list_response.rb +0 -439
  83. data/lib/telnyx/models/enterprises/reputation/number_list_response.rb +0 -154
  84. data/lib/telnyx/models/reputation/number_list_response.rb +0 -151
  85. data/rbi/telnyx/models/enterprise_list_response.rbi +0 -794
  86. data/rbi/telnyx/models/enterprises/reputation/number_list_response.rbi +0 -288
  87. data/rbi/telnyx/models/reputation/number_list_response.rbi +0 -286
  88. data/sig/telnyx/models/enterprise_list_response.rbs +0 -375
  89. data/sig/telnyx/models/enterprises/reputation/number_list_response.rbs +0 -132
  90. data/sig/telnyx/models/reputation/number_list_response.rbs +0 -130
@@ -6,447 +6,11 @@ module Telnyx
6
6
  class EnterpriseRetrieveResponse < Telnyx::Internal::Type::BaseModel
7
7
  # @!attribute data
8
8
  #
9
- # @return [Telnyx::Models::EnterpriseRetrieveResponse::Data, nil]
10
- optional :data, -> { Telnyx::Models::EnterpriseRetrieveResponse::Data }
9
+ # @return [Telnyx::Models::EnterprisePublic, nil]
10
+ optional :data, -> { Telnyx::EnterprisePublic }
11
11
 
12
12
  # @!method initialize(data: nil)
13
- # @param data [Telnyx::Models::EnterpriseRetrieveResponse::Data]
14
-
15
- # @see Telnyx::Models::EnterpriseRetrieveResponse#data
16
- class Data < Telnyx::Internal::Type::BaseModel
17
- # @!attribute id
18
- # Unique identifier of the enterprise
19
- #
20
- # @return [String, nil]
21
- optional :id, String
22
-
23
- # @!attribute billing_address
24
- #
25
- # @return [Telnyx::Models::EnterpriseRetrieveResponse::Data::BillingAddress, nil]
26
- optional :billing_address, -> { Telnyx::Models::EnterpriseRetrieveResponse::Data::BillingAddress }
27
-
28
- # @!attribute billing_contact
29
- #
30
- # @return [Telnyx::Models::EnterpriseRetrieveResponse::Data::BillingContact, nil]
31
- optional :billing_contact, -> { Telnyx::Models::EnterpriseRetrieveResponse::Data::BillingContact }
32
-
33
- # @!attribute corporate_registration_number
34
- # Corporate registration number
35
- #
36
- # @return [String, nil]
37
- optional :corporate_registration_number, String, nil?: true
38
-
39
- # @!attribute country_code
40
- # ISO 3166-1 alpha-2 country code
41
- #
42
- # @return [String, nil]
43
- optional :country_code, String
44
-
45
- # @!attribute created_at
46
- # When the enterprise was created
47
- #
48
- # @return [Time, nil]
49
- optional :created_at, Time
50
-
51
- # @!attribute customer_reference
52
- # Customer reference identifier
53
- #
54
- # @return [String, nil]
55
- optional :customer_reference, String, nil?: true
56
-
57
- # @!attribute doing_business_as
58
- # DBA name
59
- #
60
- # @return [String, nil]
61
- optional :doing_business_as, String
62
-
63
- # @!attribute dun_bradstreet_number
64
- # D-U-N-S Number
65
- #
66
- # @return [String, nil]
67
- optional :dun_bradstreet_number, String, nil?: true
68
-
69
- # @!attribute fein
70
- # Federal Employer Identification Number
71
- #
72
- # @return [String, nil]
73
- optional :fein, String, nil?: true
74
-
75
- # @!attribute industry
76
- # Industry classification
77
- #
78
- # @return [String, nil]
79
- optional :industry, String, nil?: true
80
-
81
- # @!attribute legal_name
82
- # Legal name of the enterprise
83
- #
84
- # @return [String, nil]
85
- optional :legal_name, String
86
-
87
- # @!attribute number_of_employees
88
- # Employee count range
89
- #
90
- # @return [Symbol, Telnyx::Models::EnterpriseRetrieveResponse::Data::NumberOfEmployees, nil]
91
- optional :number_of_employees,
92
- enum: -> { Telnyx::Models::EnterpriseRetrieveResponse::Data::NumberOfEmployees },
93
- nil?: true
94
-
95
- # @!attribute organization_contact
96
- # Organization contact information. Note: the response returns this object with
97
- # the phone field as 'phone' (not 'phone_number').
98
- #
99
- # @return [Telnyx::Models::EnterpriseRetrieveResponse::Data::OrganizationContact, nil]
100
- optional :organization_contact,
101
- -> { Telnyx::Models::EnterpriseRetrieveResponse::Data::OrganizationContact }
102
-
103
- # @!attribute organization_legal_type
104
- # Legal structure type
105
- #
106
- # @return [Symbol, Telnyx::Models::EnterpriseRetrieveResponse::Data::OrganizationLegalType, nil]
107
- optional :organization_legal_type,
108
- enum: -> { Telnyx::Models::EnterpriseRetrieveResponse::Data::OrganizationLegalType },
109
- nil?: true
110
-
111
- # @!attribute organization_physical_address
112
- #
113
- # @return [Telnyx::Models::EnterpriseRetrieveResponse::Data::OrganizationPhysicalAddress, nil]
114
- optional :organization_physical_address,
115
- -> { Telnyx::Models::EnterpriseRetrieveResponse::Data::OrganizationPhysicalAddress }
116
-
117
- # @!attribute organization_type
118
- # Type of organization
119
- #
120
- # @return [Symbol, Telnyx::Models::EnterpriseRetrieveResponse::Data::OrganizationType, nil]
121
- optional :organization_type,
122
- enum: -> { Telnyx::Models::EnterpriseRetrieveResponse::Data::OrganizationType }
123
-
124
- # @!attribute primary_business_domain_sic_code
125
- # SIC Code
126
- #
127
- # @return [String, nil]
128
- optional :primary_business_domain_sic_code, String, nil?: true
129
-
130
- # @!attribute professional_license_number
131
- # Professional license number
132
- #
133
- # @return [String, nil]
134
- optional :professional_license_number, String, nil?: true
135
-
136
- # @!attribute role_type
137
- # Role type in Branded Calling / Number Reputation services
138
- #
139
- # @return [Symbol, Telnyx::Models::EnterpriseRetrieveResponse::Data::RoleType, nil]
140
- optional :role_type, enum: -> { Telnyx::Models::EnterpriseRetrieveResponse::Data::RoleType }
141
-
142
- # @!attribute updated_at
143
- # When the enterprise was last updated
144
- #
145
- # @return [Time, nil]
146
- optional :updated_at, Time
147
-
148
- # @!attribute website
149
- # Company website URL
150
- #
151
- # @return [String, nil]
152
- optional :website, String, nil?: true
153
-
154
- # @!method initialize(id: nil, billing_address: nil, billing_contact: nil, corporate_registration_number: nil, country_code: nil, created_at: nil, customer_reference: nil, doing_business_as: nil, dun_bradstreet_number: nil, fein: nil, industry: nil, legal_name: nil, number_of_employees: nil, organization_contact: nil, organization_legal_type: nil, organization_physical_address: nil, organization_type: nil, primary_business_domain_sic_code: nil, professional_license_number: nil, role_type: nil, updated_at: nil, website: nil)
155
- # Some parameter documentations has been truncated, see
156
- # {Telnyx::Models::EnterpriseRetrieveResponse::Data} for more details.
157
- #
158
- # @param id [String] Unique identifier of the enterprise
159
- #
160
- # @param billing_address [Telnyx::Models::EnterpriseRetrieveResponse::Data::BillingAddress]
161
- #
162
- # @param billing_contact [Telnyx::Models::EnterpriseRetrieveResponse::Data::BillingContact]
163
- #
164
- # @param corporate_registration_number [String, nil] Corporate registration number
165
- #
166
- # @param country_code [String] ISO 3166-1 alpha-2 country code
167
- #
168
- # @param created_at [Time] When the enterprise was created
169
- #
170
- # @param customer_reference [String, nil] Customer reference identifier
171
- #
172
- # @param doing_business_as [String] DBA name
173
- #
174
- # @param dun_bradstreet_number [String, nil] D-U-N-S Number
175
- #
176
- # @param fein [String, nil] Federal Employer Identification Number
177
- #
178
- # @param industry [String, nil] Industry classification
179
- #
180
- # @param legal_name [String] Legal name of the enterprise
181
- #
182
- # @param number_of_employees [Symbol, Telnyx::Models::EnterpriseRetrieveResponse::Data::NumberOfEmployees, nil] Employee count range
183
- #
184
- # @param organization_contact [Telnyx::Models::EnterpriseRetrieveResponse::Data::OrganizationContact] Organization contact information. Note: the response returns this object with th
185
- #
186
- # @param organization_legal_type [Symbol, Telnyx::Models::EnterpriseRetrieveResponse::Data::OrganizationLegalType, nil] Legal structure type
187
- #
188
- # @param organization_physical_address [Telnyx::Models::EnterpriseRetrieveResponse::Data::OrganizationPhysicalAddress]
189
- #
190
- # @param organization_type [Symbol, Telnyx::Models::EnterpriseRetrieveResponse::Data::OrganizationType] Type of organization
191
- #
192
- # @param primary_business_domain_sic_code [String, nil] SIC Code
193
- #
194
- # @param professional_license_number [String, nil] Professional license number
195
- #
196
- # @param role_type [Symbol, Telnyx::Models::EnterpriseRetrieveResponse::Data::RoleType] Role type in Branded Calling / Number Reputation services
197
- #
198
- # @param updated_at [Time] When the enterprise was last updated
199
- #
200
- # @param website [String, nil] Company website URL
201
-
202
- # @see Telnyx::Models::EnterpriseRetrieveResponse::Data#billing_address
203
- class BillingAddress < Telnyx::Internal::Type::BaseModel
204
- # @!attribute administrative_area
205
- # State or province
206
- #
207
- # @return [String]
208
- required :administrative_area, String
209
-
210
- # @!attribute city
211
- # City name
212
- #
213
- # @return [String]
214
- required :city, String
215
-
216
- # @!attribute country
217
- # Country name (e.g., United States)
218
- #
219
- # @return [String]
220
- required :country, String
221
-
222
- # @!attribute postal_code
223
- # ZIP or postal code
224
- #
225
- # @return [String]
226
- required :postal_code, String
227
-
228
- # @!attribute street_address
229
- # Street address
230
- #
231
- # @return [String]
232
- required :street_address, String
233
-
234
- # @!attribute extended_address
235
- # Additional address line (suite, apt, etc.)
236
- #
237
- # @return [String, nil]
238
- optional :extended_address, String, nil?: true
239
-
240
- # @!method initialize(administrative_area:, city:, country:, postal_code:, street_address:, extended_address: nil)
241
- # @param administrative_area [String] State or province
242
- #
243
- # @param city [String] City name
244
- #
245
- # @param country [String] Country name (e.g., United States)
246
- #
247
- # @param postal_code [String] ZIP or postal code
248
- #
249
- # @param street_address [String] Street address
250
- #
251
- # @param extended_address [String, nil] Additional address line (suite, apt, etc.)
252
- end
253
-
254
- # @see Telnyx::Models::EnterpriseRetrieveResponse::Data#billing_contact
255
- class BillingContact < Telnyx::Internal::Type::BaseModel
256
- # @!attribute email
257
- # Contact's email address
258
- #
259
- # @return [String]
260
- required :email, String
261
-
262
- # @!attribute first_name
263
- # Contact's first name
264
- #
265
- # @return [String]
266
- required :first_name, String
267
-
268
- # @!attribute last_name
269
- # Contact's last name
270
- #
271
- # @return [String]
272
- required :last_name, String
273
-
274
- # @!attribute phone_number
275
- # Contact's phone number (10-15 digits)
276
- #
277
- # @return [String]
278
- required :phone_number, String
279
-
280
- # @!method initialize(email:, first_name:, last_name:, phone_number:)
281
- # @param email [String] Contact's email address
282
- #
283
- # @param first_name [String] Contact's first name
284
- #
285
- # @param last_name [String] Contact's last name
286
- #
287
- # @param phone_number [String] Contact's phone number (10-15 digits)
288
- end
289
-
290
- # Employee count range
291
- #
292
- # @see Telnyx::Models::EnterpriseRetrieveResponse::Data#number_of_employees
293
- module NumberOfEmployees
294
- extend Telnyx::Internal::Type::Enum
295
-
296
- NUMBER_OF_EMPLOYEES_1_10 = :"1-10"
297
- NUMBER_OF_EMPLOYEES_11_50 = :"11-50"
298
- NUMBER_OF_EMPLOYEES_51_200 = :"51-200"
299
- NUMBER_OF_EMPLOYEES_201_500 = :"201-500"
300
- NUMBER_OF_EMPLOYEES_501_2000 = :"501-2000"
301
- NUMBER_OF_EMPLOYEES_2001_10000 = :"2001-10000"
302
- NUMBER_OF_EMPLOYEES_10001 = :"10001+"
303
-
304
- # @!method self.values
305
- # @return [Array<Symbol>]
306
- end
307
-
308
- # @see Telnyx::Models::EnterpriseRetrieveResponse::Data#organization_contact
309
- class OrganizationContact < Telnyx::Internal::Type::BaseModel
310
- # @!attribute email
311
- # Contact's email address
312
- #
313
- # @return [String]
314
- required :email, String
315
-
316
- # @!attribute first_name
317
- # Contact's first name
318
- #
319
- # @return [String]
320
- required :first_name, String
321
-
322
- # @!attribute job_title
323
- # Contact's job title (required)
324
- #
325
- # @return [String]
326
- required :job_title, String
327
-
328
- # @!attribute last_name
329
- # Contact's last name
330
- #
331
- # @return [String]
332
- required :last_name, String
333
-
334
- # @!attribute phone
335
- # Contact's phone number in E.164 format
336
- #
337
- # @return [String]
338
- required :phone, String
339
-
340
- # @!method initialize(email:, first_name:, job_title:, last_name:, phone:)
341
- # Organization contact information. Note: the response returns this object with
342
- # the phone field as 'phone' (not 'phone_number').
343
- #
344
- # @param email [String] Contact's email address
345
- #
346
- # @param first_name [String] Contact's first name
347
- #
348
- # @param job_title [String] Contact's job title (required)
349
- #
350
- # @param last_name [String] Contact's last name
351
- #
352
- # @param phone [String] Contact's phone number in E.164 format
353
- end
354
-
355
- # Legal structure type
356
- #
357
- # @see Telnyx::Models::EnterpriseRetrieveResponse::Data#organization_legal_type
358
- module OrganizationLegalType
359
- extend Telnyx::Internal::Type::Enum
360
-
361
- CORPORATION = :corporation
362
- LLC = :llc
363
- PARTNERSHIP = :partnership
364
- NONPROFIT = :nonprofit
365
- OTHER = :other
366
-
367
- # @!method self.values
368
- # @return [Array<Symbol>]
369
- end
370
-
371
- # @see Telnyx::Models::EnterpriseRetrieveResponse::Data#organization_physical_address
372
- class OrganizationPhysicalAddress < Telnyx::Internal::Type::BaseModel
373
- # @!attribute administrative_area
374
- # State or province
375
- #
376
- # @return [String]
377
- required :administrative_area, String
378
-
379
- # @!attribute city
380
- # City name
381
- #
382
- # @return [String]
383
- required :city, String
384
-
385
- # @!attribute country
386
- # Country name (e.g., United States)
387
- #
388
- # @return [String]
389
- required :country, String
390
-
391
- # @!attribute postal_code
392
- # ZIP or postal code
393
- #
394
- # @return [String]
395
- required :postal_code, String
396
-
397
- # @!attribute street_address
398
- # Street address
399
- #
400
- # @return [String]
401
- required :street_address, String
402
-
403
- # @!attribute extended_address
404
- # Additional address line (suite, apt, etc.)
405
- #
406
- # @return [String, nil]
407
- optional :extended_address, String, nil?: true
408
-
409
- # @!method initialize(administrative_area:, city:, country:, postal_code:, street_address:, extended_address: nil)
410
- # @param administrative_area [String] State or province
411
- #
412
- # @param city [String] City name
413
- #
414
- # @param country [String] Country name (e.g., United States)
415
- #
416
- # @param postal_code [String] ZIP or postal code
417
- #
418
- # @param street_address [String] Street address
419
- #
420
- # @param extended_address [String, nil] Additional address line (suite, apt, etc.)
421
- end
422
-
423
- # Type of organization
424
- #
425
- # @see Telnyx::Models::EnterpriseRetrieveResponse::Data#organization_type
426
- module OrganizationType
427
- extend Telnyx::Internal::Type::Enum
428
-
429
- COMMERCIAL = :commercial
430
- GOVERNMENT = :government
431
- NON_PROFIT = :non_profit
432
-
433
- # @!method self.values
434
- # @return [Array<Symbol>]
435
- end
436
-
437
- # Role type in Branded Calling / Number Reputation services
438
- #
439
- # @see Telnyx::Models::EnterpriseRetrieveResponse::Data#role_type
440
- module RoleType
441
- extend Telnyx::Internal::Type::Enum
442
-
443
- ENTERPRISE = :enterprise
444
- BPO = :bpo
445
-
446
- # @!method self.values
447
- # @return [Array<Symbol>]
448
- end
449
- end
13
+ # @param data [Telnyx::Models::EnterprisePublic]
450
14
  end
451
15
  end
452
16
  end