telnyx 5.65.0 → 5.66.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 (120) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +13 -0
  5. data/lib/telnyx/models/enterprise_create_params.rb +411 -0
  6. data/lib/telnyx/models/enterprise_create_response.rb +450 -0
  7. data/lib/telnyx/models/enterprise_delete_params.rb +20 -0
  8. data/lib/telnyx/models/enterprise_list_params.rb +38 -0
  9. data/lib/telnyx/models/enterprise_list_response.rb +439 -0
  10. data/lib/telnyx/models/enterprise_retrieve_params.rb +20 -0
  11. data/lib/telnyx/models/enterprise_retrieve_response.rb +452 -0
  12. data/lib/telnyx/models/enterprise_update_params.rb +364 -0
  13. data/lib/telnyx/models/enterprise_update_response.rb +450 -0
  14. data/lib/telnyx/models/enterprises/reputation/number_create_params.rb +33 -0
  15. data/lib/telnyx/models/enterprises/reputation/number_create_response.rb +106 -0
  16. data/lib/telnyx/models/enterprises/reputation/number_delete_params.rb +30 -0
  17. data/lib/telnyx/models/enterprises/reputation/number_list_params.rb +49 -0
  18. data/lib/telnyx/models/enterprises/reputation/number_list_response.rb +154 -0
  19. data/lib/telnyx/models/enterprises/reputation/number_retrieve_params.rb +45 -0
  20. data/lib/telnyx/models/enterprises/reputation/number_retrieve_response.rb +165 -0
  21. data/lib/telnyx/models/enterprises/reputation_create_params.rb +58 -0
  22. data/lib/telnyx/models/enterprises/reputation_create_response.rb +111 -0
  23. data/lib/telnyx/models/enterprises/reputation_delete_all_params.rb +22 -0
  24. data/lib/telnyx/models/enterprises/reputation_list_params.rb +22 -0
  25. data/lib/telnyx/models/enterprises/reputation_list_response.rb +111 -0
  26. data/lib/telnyx/models/enterprises/reputation_update_frequency_params.rb +47 -0
  27. data/lib/telnyx/models/enterprises/reputation_update_frequency_response.rb +112 -0
  28. data/lib/telnyx/models/reputation/number_delete_params.rb +22 -0
  29. data/lib/telnyx/models/reputation/number_list_params.rb +40 -0
  30. data/lib/telnyx/models/reputation/number_list_response.rb +151 -0
  31. data/lib/telnyx/models/reputation/number_retrieve_params.rb +35 -0
  32. data/lib/telnyx/models/reputation/number_retrieve_response.rb +163 -0
  33. data/lib/telnyx/models/terms_of_service/number_reputation_agree_params.rb +16 -0
  34. data/lib/telnyx/models.rb +16 -0
  35. data/lib/telnyx/resources/enterprises/reputation/numbers.rb +174 -0
  36. data/lib/telnyx/resources/enterprises/reputation.rb +166 -0
  37. data/lib/telnyx/resources/enterprises.rb +217 -0
  38. data/lib/telnyx/resources/reputation/numbers.rb +102 -0
  39. data/lib/telnyx/resources/reputation.rb +20 -0
  40. data/lib/telnyx/resources/terms_of_service/number_reputation.rb +39 -0
  41. data/lib/telnyx/resources/terms_of_service.rb +19 -0
  42. data/lib/telnyx/version.rb +1 -1
  43. data/lib/telnyx.rb +36 -0
  44. data/rbi/telnyx/client.rbi +10 -0
  45. data/rbi/telnyx/models/enterprise_create_params.rbi +719 -0
  46. data/rbi/telnyx/models/enterprise_create_response.rbi +841 -0
  47. data/rbi/telnyx/models/enterprise_delete_params.rbi +35 -0
  48. data/rbi/telnyx/models/enterprise_list_params.rbi +68 -0
  49. data/rbi/telnyx/models/enterprise_list_response.rbi +794 -0
  50. data/rbi/telnyx/models/enterprise_retrieve_params.rbi +35 -0
  51. data/rbi/telnyx/models/enterprise_retrieve_response.rbi +843 -0
  52. data/rbi/telnyx/models/enterprise_update_params.rbi +651 -0
  53. data/rbi/telnyx/models/enterprise_update_response.rbi +841 -0
  54. data/rbi/telnyx/models/enterprises/reputation/number_create_params.rbi +56 -0
  55. data/rbi/telnyx/models/enterprises/reputation/number_create_response.rbi +238 -0
  56. data/rbi/telnyx/models/enterprises/reputation/number_delete_params.rbi +50 -0
  57. data/rbi/telnyx/models/enterprises/reputation/number_list_params.rbi +81 -0
  58. data/rbi/telnyx/models/enterprises/reputation/number_list_response.rbi +288 -0
  59. data/rbi/telnyx/models/enterprises/reputation/number_retrieve_params.rbi +67 -0
  60. data/rbi/telnyx/models/enterprises/reputation/number_retrieve_response.rbi +335 -0
  61. data/rbi/telnyx/models/enterprises/reputation_create_params.rbi +135 -0
  62. data/rbi/telnyx/models/enterprises/reputation_create_response.rbi +277 -0
  63. data/rbi/telnyx/models/enterprises/reputation_delete_all_params.rbi +40 -0
  64. data/rbi/telnyx/models/enterprises/reputation_list_params.rbi +40 -0
  65. data/rbi/telnyx/models/enterprises/reputation_list_response.rbi +273 -0
  66. data/rbi/telnyx/models/enterprises/reputation_update_frequency_params.rbi +115 -0
  67. data/rbi/telnyx/models/enterprises/reputation_update_frequency_response.rbi +278 -0
  68. data/rbi/telnyx/models/reputation/number_delete_params.rbi +40 -0
  69. data/rbi/telnyx/models/reputation/number_list_params.rbi +73 -0
  70. data/rbi/telnyx/models/reputation/number_list_response.rbi +286 -0
  71. data/rbi/telnyx/models/reputation/number_retrieve_params.rbi +59 -0
  72. data/rbi/telnyx/models/reputation/number_retrieve_response.rbi +328 -0
  73. data/rbi/telnyx/models/terms_of_service/number_reputation_agree_params.rbi +32 -0
  74. data/rbi/telnyx/models.rbi +16 -0
  75. data/rbi/telnyx/resources/enterprises/reputation/numbers.rbi +142 -0
  76. data/rbi/telnyx/resources/enterprises/reputation.rbi +140 -0
  77. data/rbi/telnyx/resources/enterprises.rbi +226 -0
  78. data/rbi/telnyx/resources/reputation/numbers.rbi +80 -0
  79. data/rbi/telnyx/resources/reputation.rbi +17 -0
  80. data/rbi/telnyx/resources/terms_of_service/number_reputation.rbi +24 -0
  81. data/rbi/telnyx/resources/terms_of_service.rbi +16 -0
  82. data/sig/telnyx/client.rbs +6 -0
  83. data/sig/telnyx/models/enterprise_create_params.rbs +344 -0
  84. data/sig/telnyx/models/enterprise_create_response.rbs +392 -0
  85. data/sig/telnyx/models/enterprise_delete_params.rbs +23 -0
  86. data/sig/telnyx/models/enterprise_list_params.rbs +38 -0
  87. data/sig/telnyx/models/enterprise_list_response.rbs +375 -0
  88. data/sig/telnyx/models/enterprise_retrieve_params.rbs +23 -0
  89. data/sig/telnyx/models/enterprise_retrieve_response.rbs +392 -0
  90. data/sig/telnyx/models/enterprise_update_params.rbs +341 -0
  91. data/sig/telnyx/models/enterprise_update_response.rbs +392 -0
  92. data/sig/telnyx/models/enterprises/reputation/number_create_params.rbs +32 -0
  93. data/sig/telnyx/models/enterprises/reputation/number_create_response.rbs +124 -0
  94. data/sig/telnyx/models/enterprises/reputation/number_delete_params.rbs +32 -0
  95. data/sig/telnyx/models/enterprises/reputation/number_list_params.rbs +51 -0
  96. data/sig/telnyx/models/enterprises/reputation/number_list_response.rbs +132 -0
  97. data/sig/telnyx/models/enterprises/reputation/number_retrieve_params.rbs +38 -0
  98. data/sig/telnyx/models/enterprises/reputation/number_retrieve_response.rbs +153 -0
  99. data/sig/telnyx/models/enterprises/reputation_create_params.rbs +58 -0
  100. data/sig/telnyx/models/enterprises/reputation_create_response.rbs +114 -0
  101. data/sig/telnyx/models/enterprises/reputation_delete_all_params.rbs +25 -0
  102. data/sig/telnyx/models/enterprises/reputation_list_params.rbs +25 -0
  103. data/sig/telnyx/models/enterprises/reputation_list_response.rbs +114 -0
  104. data/sig/telnyx/models/enterprises/reputation_update_frequency_params.rbs +49 -0
  105. data/sig/telnyx/models/enterprises/reputation_update_frequency_response.rbs +116 -0
  106. data/sig/telnyx/models/reputation/number_delete_params.rbs +25 -0
  107. data/sig/telnyx/models/reputation/number_list_params.rbs +40 -0
  108. data/sig/telnyx/models/reputation/number_list_response.rbs +130 -0
  109. data/sig/telnyx/models/reputation/number_retrieve_params.rbs +32 -0
  110. data/sig/telnyx/models/reputation/number_retrieve_response.rbs +149 -0
  111. data/sig/telnyx/models/terms_of_service/number_reputation_agree_params.rbs +17 -0
  112. data/sig/telnyx/models.rbs +16 -0
  113. data/sig/telnyx/resources/enterprises/reputation/numbers.rbs +38 -0
  114. data/sig/telnyx/resources/enterprises/reputation.rbs +34 -0
  115. data/sig/telnyx/resources/enterprises.rbs +70 -0
  116. data/sig/telnyx/resources/reputation/numbers.rbs +27 -0
  117. data/sig/telnyx/resources/reputation.rbs +9 -0
  118. data/sig/telnyx/resources/terms_of_service/number_reputation.rbs +11 -0
  119. data/sig/telnyx/resources/terms_of_service.rbs +9 -0
  120. metadata +110 -2
@@ -0,0 +1,154 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Enterprises
6
+ module Reputation
7
+ # @see Telnyx::Resources::Enterprises::Reputation::Numbers#list
8
+ class NumberListResponse < Telnyx::Internal::Type::BaseModel
9
+ # @!attribute id
10
+ # Unique identifier
11
+ #
12
+ # @return [String, nil]
13
+ optional :id, String
14
+
15
+ # @!attribute created_at
16
+ # When the number was associated
17
+ #
18
+ # @return [Time, nil]
19
+ optional :created_at, Time
20
+
21
+ # @!attribute enterprise_id
22
+ # ID of the associated enterprise
23
+ #
24
+ # @return [String, nil]
25
+ optional :enterprise_id, String
26
+
27
+ # @!attribute phone_number
28
+ # Phone number in E.164 format
29
+ #
30
+ # @return [String, nil]
31
+ optional :phone_number, String
32
+
33
+ # @!attribute reputation_data
34
+ # Reputation metrics (null if not yet fetched)
35
+ #
36
+ # @return [Telnyx::Models::Enterprises::Reputation::NumberListResponse::ReputationData::ReputationData, Object, nil]
37
+ optional :reputation_data,
38
+ union: -> { Telnyx::Models::Enterprises::Reputation::NumberListResponse::ReputationData }
39
+
40
+ # @!attribute updated_at
41
+ # When the record was last updated
42
+ #
43
+ # @return [Time, nil]
44
+ optional :updated_at, Time
45
+
46
+ # @!method initialize(id: nil, created_at: nil, enterprise_id: nil, phone_number: nil, reputation_data: nil, updated_at: nil)
47
+ # @param id [String] Unique identifier
48
+ #
49
+ # @param created_at [Time] When the number was associated
50
+ #
51
+ # @param enterprise_id [String] ID of the associated enterprise
52
+ #
53
+ # @param phone_number [String] Phone number in E.164 format
54
+ #
55
+ # @param reputation_data [Telnyx::Models::Enterprises::Reputation::NumberListResponse::ReputationData::ReputationData, Object, nil] Reputation metrics (null if not yet fetched)
56
+ #
57
+ # @param updated_at [Time] When the record was last updated
58
+
59
+ # Reputation metrics (null if not yet fetched)
60
+ #
61
+ # @see Telnyx::Models::Enterprises::Reputation::NumberListResponse#reputation_data
62
+ module ReputationData
63
+ extend Telnyx::Internal::Type::Union
64
+
65
+ # Reputation metrics
66
+ variant -> { Telnyx::Models::Enterprises::Reputation::NumberListResponse::ReputationData::ReputationData }
67
+
68
+ variant Telnyx::Internal::Type::Unknown
69
+
70
+ class ReputationData < Telnyx::Internal::Type::BaseModel
71
+ # @!attribute connection_score
72
+ # Connection quality metric (0–100)
73
+ #
74
+ # @return [Integer, nil]
75
+ optional :connection_score, Integer, nil?: true
76
+
77
+ # @!attribute engagement_score
78
+ # Engagement metric (0–100). Higher = more positive engagement
79
+ #
80
+ # @return [Integer, nil]
81
+ optional :engagement_score, Integer, nil?: true
82
+
83
+ # @!attribute last_refreshed_at
84
+ # Timestamp of the last reputation data refresh
85
+ #
86
+ # @return [Time, nil]
87
+ optional :last_refreshed_at, Time, nil?: true
88
+
89
+ # @!attribute maturity_score
90
+ # Maturity metric (0–100). Higher = more established number
91
+ #
92
+ # @return [Integer, nil]
93
+ optional :maturity_score, Integer, nil?: true
94
+
95
+ # @!attribute sentiment_score
96
+ # Sentiment metric (0–100). Higher = more positive sentiment
97
+ #
98
+ # @return [Integer, nil]
99
+ optional :sentiment_score, Integer, nil?: true
100
+
101
+ # @!attribute spam_category
102
+ # Spam category classification (e.g., Telemarketing, Debt Collector)
103
+ #
104
+ # @return [String, nil]
105
+ optional :spam_category, String, nil?: true
106
+
107
+ # @!attribute spam_risk
108
+ # Overall spam risk level
109
+ #
110
+ # @return [Symbol, Telnyx::Models::Enterprises::Reputation::NumberListResponse::ReputationData::ReputationData::SpamRisk, nil]
111
+ optional :spam_risk,
112
+ enum: -> { Telnyx::Models::Enterprises::Reputation::NumberListResponse::ReputationData::ReputationData::SpamRisk },
113
+ nil?: true
114
+
115
+ # @!method initialize(connection_score: nil, engagement_score: nil, last_refreshed_at: nil, maturity_score: nil, sentiment_score: nil, spam_category: nil, spam_risk: nil)
116
+ # Reputation metrics
117
+ #
118
+ # @param connection_score [Integer, nil] Connection quality metric (0–100)
119
+ #
120
+ # @param engagement_score [Integer, nil] Engagement metric (0–100). Higher = more positive engagement
121
+ #
122
+ # @param last_refreshed_at [Time, nil] Timestamp of the last reputation data refresh
123
+ #
124
+ # @param maturity_score [Integer, nil] Maturity metric (0–100). Higher = more established number
125
+ #
126
+ # @param sentiment_score [Integer, nil] Sentiment metric (0–100). Higher = more positive sentiment
127
+ #
128
+ # @param spam_category [String, nil] Spam category classification (e.g., Telemarketing, Debt Collector)
129
+ #
130
+ # @param spam_risk [Symbol, Telnyx::Models::Enterprises::Reputation::NumberListResponse::ReputationData::ReputationData::SpamRisk, nil] Overall spam risk level
131
+
132
+ # Overall spam risk level
133
+ #
134
+ # @see Telnyx::Models::Enterprises::Reputation::NumberListResponse::ReputationData::ReputationData#spam_risk
135
+ module SpamRisk
136
+ extend Telnyx::Internal::Type::Enum
137
+
138
+ LOW = :low
139
+ MEDIUM = :medium
140
+ HIGH = :high
141
+
142
+ # @!method self.values
143
+ # @return [Array<Symbol>]
144
+ end
145
+ end
146
+
147
+ # @!method self.variants
148
+ # @return [Array(Telnyx::Models::Enterprises::Reputation::NumberListResponse::ReputationData::ReputationData, Object)]
149
+ end
150
+ end
151
+ end
152
+ end
153
+ end
154
+ end
@@ -0,0 +1,45 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Enterprises
6
+ module Reputation
7
+ # @see Telnyx::Resources::Enterprises::Reputation::Numbers#retrieve
8
+ class NumberRetrieveParams < Telnyx::Internal::Type::BaseModel
9
+ extend Telnyx::Internal::Type::RequestParameters::Converter
10
+ include Telnyx::Internal::Type::RequestParameters
11
+
12
+ # @!attribute enterprise_id
13
+ #
14
+ # @return [String]
15
+ required :enterprise_id, String
16
+
17
+ # @!attribute phone_number
18
+ #
19
+ # @return [String]
20
+ required :phone_number, String
21
+
22
+ # @!attribute fresh
23
+ # When true, fetches fresh reputation data (incurs API cost). When false, returns
24
+ # cached data.
25
+ #
26
+ # @return [Boolean, nil]
27
+ optional :fresh, Telnyx::Internal::Type::Boolean
28
+
29
+ # @!method initialize(enterprise_id:, phone_number:, fresh: nil, request_options: {})
30
+ # Some parameter documentations has been truncated, see
31
+ # {Telnyx::Models::Enterprises::Reputation::NumberRetrieveParams} for more
32
+ # details.
33
+ #
34
+ # @param enterprise_id [String]
35
+ #
36
+ # @param phone_number [String]
37
+ #
38
+ # @param fresh [Boolean] When true, fetches fresh reputation data (incurs API cost). When false, returns
39
+ #
40
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
41
+ end
42
+ end
43
+ end
44
+ end
45
+ end
@@ -0,0 +1,165 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Enterprises
6
+ module Reputation
7
+ # @see Telnyx::Resources::Enterprises::Reputation::Numbers#retrieve
8
+ class NumberRetrieveResponse < Telnyx::Internal::Type::BaseModel
9
+ # @!attribute data
10
+ #
11
+ # @return [Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data, nil]
12
+ optional :data, -> { Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data }
13
+
14
+ # @!method initialize(data: nil)
15
+ # @param data [Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data]
16
+
17
+ # @see Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse#data
18
+ class Data < Telnyx::Internal::Type::BaseModel
19
+ # @!attribute id
20
+ # Unique identifier
21
+ #
22
+ # @return [String, nil]
23
+ optional :id, String
24
+
25
+ # @!attribute created_at
26
+ # When the number was associated
27
+ #
28
+ # @return [Time, nil]
29
+ optional :created_at, Time
30
+
31
+ # @!attribute enterprise_id
32
+ # ID of the associated enterprise
33
+ #
34
+ # @return [String, nil]
35
+ optional :enterprise_id, String
36
+
37
+ # @!attribute phone_number
38
+ # Phone number in E.164 format
39
+ #
40
+ # @return [String, nil]
41
+ optional :phone_number, String
42
+
43
+ # @!attribute reputation_data
44
+ # Reputation metrics (null if not yet fetched)
45
+ #
46
+ # @return [Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData, Object, nil]
47
+ optional :reputation_data,
48
+ union: -> { Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data::ReputationData }
49
+
50
+ # @!attribute updated_at
51
+ # When the record was last updated
52
+ #
53
+ # @return [Time, nil]
54
+ optional :updated_at, Time
55
+
56
+ # @!method initialize(id: nil, created_at: nil, enterprise_id: nil, phone_number: nil, reputation_data: nil, updated_at: nil)
57
+ # @param id [String] Unique identifier
58
+ #
59
+ # @param created_at [Time] When the number was associated
60
+ #
61
+ # @param enterprise_id [String] ID of the associated enterprise
62
+ #
63
+ # @param phone_number [String] Phone number in E.164 format
64
+ #
65
+ # @param reputation_data [Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData, Object, nil] Reputation metrics (null if not yet fetched)
66
+ #
67
+ # @param updated_at [Time] When the record was last updated
68
+
69
+ # Reputation metrics (null if not yet fetched)
70
+ #
71
+ # @see Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data#reputation_data
72
+ module ReputationData
73
+ extend Telnyx::Internal::Type::Union
74
+
75
+ # Reputation metrics
76
+ variant -> { Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData }
77
+
78
+ variant Telnyx::Internal::Type::Unknown
79
+
80
+ class ReputationData < Telnyx::Internal::Type::BaseModel
81
+ # @!attribute connection_score
82
+ # Connection quality metric (0–100)
83
+ #
84
+ # @return [Integer, nil]
85
+ optional :connection_score, Integer, nil?: true
86
+
87
+ # @!attribute engagement_score
88
+ # Engagement metric (0–100). Higher = more positive engagement
89
+ #
90
+ # @return [Integer, nil]
91
+ optional :engagement_score, Integer, nil?: true
92
+
93
+ # @!attribute last_refreshed_at
94
+ # Timestamp of the last reputation data refresh
95
+ #
96
+ # @return [Time, nil]
97
+ optional :last_refreshed_at, Time, nil?: true
98
+
99
+ # @!attribute maturity_score
100
+ # Maturity metric (0–100). Higher = more established number
101
+ #
102
+ # @return [Integer, nil]
103
+ optional :maturity_score, Integer, nil?: true
104
+
105
+ # @!attribute sentiment_score
106
+ # Sentiment metric (0–100). Higher = more positive sentiment
107
+ #
108
+ # @return [Integer, nil]
109
+ optional :sentiment_score, Integer, nil?: true
110
+
111
+ # @!attribute spam_category
112
+ # Spam category classification (e.g., Telemarketing, Debt Collector)
113
+ #
114
+ # @return [String, nil]
115
+ optional :spam_category, String, nil?: true
116
+
117
+ # @!attribute spam_risk
118
+ # Overall spam risk level
119
+ #
120
+ # @return [Symbol, Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData::SpamRisk, nil]
121
+ optional :spam_risk,
122
+ enum: -> { Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData::SpamRisk },
123
+ nil?: true
124
+
125
+ # @!method initialize(connection_score: nil, engagement_score: nil, last_refreshed_at: nil, maturity_score: nil, sentiment_score: nil, spam_category: nil, spam_risk: nil)
126
+ # Reputation metrics
127
+ #
128
+ # @param connection_score [Integer, nil] Connection quality metric (0–100)
129
+ #
130
+ # @param engagement_score [Integer, nil] Engagement metric (0–100). Higher = more positive engagement
131
+ #
132
+ # @param last_refreshed_at [Time, nil] Timestamp of the last reputation data refresh
133
+ #
134
+ # @param maturity_score [Integer, nil] Maturity metric (0–100). Higher = more established number
135
+ #
136
+ # @param sentiment_score [Integer, nil] Sentiment metric (0–100). Higher = more positive sentiment
137
+ #
138
+ # @param spam_category [String, nil] Spam category classification (e.g., Telemarketing, Debt Collector)
139
+ #
140
+ # @param spam_risk [Symbol, Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData::SpamRisk, nil] Overall spam risk level
141
+
142
+ # Overall spam risk level
143
+ #
144
+ # @see Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData#spam_risk
145
+ module SpamRisk
146
+ extend Telnyx::Internal::Type::Enum
147
+
148
+ LOW = :low
149
+ MEDIUM = :medium
150
+ HIGH = :high
151
+
152
+ # @!method self.values
153
+ # @return [Array<Symbol>]
154
+ end
155
+ end
156
+
157
+ # @!method self.variants
158
+ # @return [Array(Telnyx::Models::Enterprises::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData, Object)]
159
+ end
160
+ end
161
+ end
162
+ end
163
+ end
164
+ end
165
+ end
@@ -0,0 +1,58 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Enterprises
6
+ # @see Telnyx::Resources::Enterprises::Reputation#create
7
+ class ReputationCreateParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ # @!attribute enterprise_id
12
+ #
13
+ # @return [String]
14
+ required :enterprise_id, String
15
+
16
+ # @!attribute loa_document_id
17
+ # ID of the signed Letter of Authorization (LOA) document uploaded to the document
18
+ # service
19
+ #
20
+ # @return [String]
21
+ required :loa_document_id, String
22
+
23
+ # @!attribute check_frequency
24
+ # Frequency for automatically refreshing reputation data
25
+ #
26
+ # @return [Symbol, Telnyx::Models::Enterprises::ReputationCreateParams::CheckFrequency, nil]
27
+ optional :check_frequency, enum: -> { Telnyx::Enterprises::ReputationCreateParams::CheckFrequency }
28
+
29
+ # @!method initialize(enterprise_id:, loa_document_id:, check_frequency: nil, request_options: {})
30
+ # Some parameter documentations has been truncated, see
31
+ # {Telnyx::Models::Enterprises::ReputationCreateParams} for more details.
32
+ #
33
+ # @param enterprise_id [String]
34
+ #
35
+ # @param loa_document_id [String] ID of the signed Letter of Authorization (LOA) document uploaded to the document
36
+ #
37
+ # @param check_frequency [Symbol, Telnyx::Models::Enterprises::ReputationCreateParams::CheckFrequency] Frequency for automatically refreshing reputation data
38
+ #
39
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
40
+
41
+ # Frequency for automatically refreshing reputation data
42
+ module CheckFrequency
43
+ extend Telnyx::Internal::Type::Enum
44
+
45
+ BUSINESS_DAILY = :business_daily
46
+ DAILY = :daily
47
+ WEEKLY = :weekly
48
+ BIWEEKLY = :biweekly
49
+ MONTHLY = :monthly
50
+ NEVER = :never
51
+
52
+ # @!method self.values
53
+ # @return [Array<Symbol>]
54
+ end
55
+ end
56
+ end
57
+ end
58
+ end
@@ -0,0 +1,111 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Enterprises
6
+ # @see Telnyx::Resources::Enterprises::Reputation#create
7
+ class ReputationCreateResponse < Telnyx::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ #
10
+ # @return [Telnyx::Models::Enterprises::ReputationCreateResponse::Data, nil]
11
+ optional :data, -> { Telnyx::Models::Enterprises::ReputationCreateResponse::Data }
12
+
13
+ # @!method initialize(data: nil)
14
+ # @param data [Telnyx::Models::Enterprises::ReputationCreateResponse::Data]
15
+
16
+ # @see Telnyx::Models::Enterprises::ReputationCreateResponse#data
17
+ class Data < Telnyx::Internal::Type::BaseModel
18
+ # @!attribute check_frequency
19
+ # Frequency for refreshing reputation data
20
+ #
21
+ # @return [Symbol, Telnyx::Models::Enterprises::ReputationCreateResponse::Data::CheckFrequency, nil]
22
+ optional :check_frequency,
23
+ enum: -> { Telnyx::Models::Enterprises::ReputationCreateResponse::Data::CheckFrequency }
24
+
25
+ # @!attribute created_at
26
+ # When the reputation settings were created
27
+ #
28
+ # @return [Time, nil]
29
+ optional :created_at, Time
30
+
31
+ # @!attribute enterprise_id
32
+ # ID of the associated enterprise
33
+ #
34
+ # @return [String, nil]
35
+ optional :enterprise_id, String
36
+
37
+ # @!attribute loa_document_id
38
+ # ID of the signed LOA document
39
+ #
40
+ # @return [String, nil]
41
+ optional :loa_document_id, String, nil?: true
42
+
43
+ # @!attribute rejection_reasons
44
+ # Reasons for rejection (present when status is rejected)
45
+ #
46
+ # @return [Array<String>, nil]
47
+ optional :rejection_reasons, Telnyx::Internal::Type::ArrayOf[String], nil?: true
48
+
49
+ # @!attribute status
50
+ # Current enrollment status
51
+ #
52
+ # @return [Symbol, Telnyx::Models::Enterprises::ReputationCreateResponse::Data::Status, nil]
53
+ optional :status, enum: -> { Telnyx::Models::Enterprises::ReputationCreateResponse::Data::Status }
54
+
55
+ # @!attribute updated_at
56
+ # When the reputation settings were last updated
57
+ #
58
+ # @return [Time, nil]
59
+ optional :updated_at, Time
60
+
61
+ # @!method initialize(check_frequency: nil, created_at: nil, enterprise_id: nil, loa_document_id: nil, rejection_reasons: nil, status: nil, updated_at: nil)
62
+ # @param check_frequency [Symbol, Telnyx::Models::Enterprises::ReputationCreateResponse::Data::CheckFrequency] Frequency for refreshing reputation data
63
+ #
64
+ # @param created_at [Time] When the reputation settings were created
65
+ #
66
+ # @param enterprise_id [String] ID of the associated enterprise
67
+ #
68
+ # @param loa_document_id [String, nil] ID of the signed LOA document
69
+ #
70
+ # @param rejection_reasons [Array<String>, nil] Reasons for rejection (present when status is rejected)
71
+ #
72
+ # @param status [Symbol, Telnyx::Models::Enterprises::ReputationCreateResponse::Data::Status] Current enrollment status
73
+ #
74
+ # @param updated_at [Time] When the reputation settings were last updated
75
+
76
+ # Frequency for refreshing reputation data
77
+ #
78
+ # @see Telnyx::Models::Enterprises::ReputationCreateResponse::Data#check_frequency
79
+ module CheckFrequency
80
+ extend Telnyx::Internal::Type::Enum
81
+
82
+ BUSINESS_DAILY = :business_daily
83
+ DAILY = :daily
84
+ WEEKLY = :weekly
85
+ BIWEEKLY = :biweekly
86
+ MONTHLY = :monthly
87
+ NEVER = :never
88
+
89
+ # @!method self.values
90
+ # @return [Array<Symbol>]
91
+ end
92
+
93
+ # Current enrollment status
94
+ #
95
+ # @see Telnyx::Models::Enterprises::ReputationCreateResponse::Data#status
96
+ module Status
97
+ extend Telnyx::Internal::Type::Enum
98
+
99
+ PENDING = :pending
100
+ APPROVED = :approved
101
+ REJECTED = :rejected
102
+ DELETED = :deleted
103
+
104
+ # @!method self.values
105
+ # @return [Array<Symbol>]
106
+ end
107
+ end
108
+ end
109
+ end
110
+ end
111
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Enterprises
6
+ # @see Telnyx::Resources::Enterprises::Reputation#delete_all
7
+ class ReputationDeleteAllParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ # @!attribute enterprise_id
12
+ #
13
+ # @return [String]
14
+ required :enterprise_id, String
15
+
16
+ # @!method initialize(enterprise_id:, request_options: {})
17
+ # @param enterprise_id [String]
18
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Enterprises
6
+ # @see Telnyx::Resources::Enterprises::Reputation#list
7
+ class ReputationListParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ # @!attribute enterprise_id
12
+ #
13
+ # @return [String]
14
+ required :enterprise_id, String
15
+
16
+ # @!method initialize(enterprise_id:, request_options: {})
17
+ # @param enterprise_id [String]
18
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,111 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Enterprises
6
+ # @see Telnyx::Resources::Enterprises::Reputation#list
7
+ class ReputationListResponse < Telnyx::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ #
10
+ # @return [Telnyx::Models::Enterprises::ReputationListResponse::Data, nil]
11
+ optional :data, -> { Telnyx::Models::Enterprises::ReputationListResponse::Data }
12
+
13
+ # @!method initialize(data: nil)
14
+ # @param data [Telnyx::Models::Enterprises::ReputationListResponse::Data]
15
+
16
+ # @see Telnyx::Models::Enterprises::ReputationListResponse#data
17
+ class Data < Telnyx::Internal::Type::BaseModel
18
+ # @!attribute check_frequency
19
+ # Frequency for refreshing reputation data
20
+ #
21
+ # @return [Symbol, Telnyx::Models::Enterprises::ReputationListResponse::Data::CheckFrequency, nil]
22
+ optional :check_frequency,
23
+ enum: -> { Telnyx::Models::Enterprises::ReputationListResponse::Data::CheckFrequency }
24
+
25
+ # @!attribute created_at
26
+ # When the reputation settings were created
27
+ #
28
+ # @return [Time, nil]
29
+ optional :created_at, Time
30
+
31
+ # @!attribute enterprise_id
32
+ # ID of the associated enterprise
33
+ #
34
+ # @return [String, nil]
35
+ optional :enterprise_id, String
36
+
37
+ # @!attribute loa_document_id
38
+ # ID of the signed LOA document
39
+ #
40
+ # @return [String, nil]
41
+ optional :loa_document_id, String, nil?: true
42
+
43
+ # @!attribute rejection_reasons
44
+ # Reasons for rejection (present when status is rejected)
45
+ #
46
+ # @return [Array<String>, nil]
47
+ optional :rejection_reasons, Telnyx::Internal::Type::ArrayOf[String], nil?: true
48
+
49
+ # @!attribute status
50
+ # Current enrollment status
51
+ #
52
+ # @return [Symbol, Telnyx::Models::Enterprises::ReputationListResponse::Data::Status, nil]
53
+ optional :status, enum: -> { Telnyx::Models::Enterprises::ReputationListResponse::Data::Status }
54
+
55
+ # @!attribute updated_at
56
+ # When the reputation settings were last updated
57
+ #
58
+ # @return [Time, nil]
59
+ optional :updated_at, Time
60
+
61
+ # @!method initialize(check_frequency: nil, created_at: nil, enterprise_id: nil, loa_document_id: nil, rejection_reasons: nil, status: nil, updated_at: nil)
62
+ # @param check_frequency [Symbol, Telnyx::Models::Enterprises::ReputationListResponse::Data::CheckFrequency] Frequency for refreshing reputation data
63
+ #
64
+ # @param created_at [Time] When the reputation settings were created
65
+ #
66
+ # @param enterprise_id [String] ID of the associated enterprise
67
+ #
68
+ # @param loa_document_id [String, nil] ID of the signed LOA document
69
+ #
70
+ # @param rejection_reasons [Array<String>, nil] Reasons for rejection (present when status is rejected)
71
+ #
72
+ # @param status [Symbol, Telnyx::Models::Enterprises::ReputationListResponse::Data::Status] Current enrollment status
73
+ #
74
+ # @param updated_at [Time] When the reputation settings were last updated
75
+
76
+ # Frequency for refreshing reputation data
77
+ #
78
+ # @see Telnyx::Models::Enterprises::ReputationListResponse::Data#check_frequency
79
+ module CheckFrequency
80
+ extend Telnyx::Internal::Type::Enum
81
+
82
+ BUSINESS_DAILY = :business_daily
83
+ DAILY = :daily
84
+ WEEKLY = :weekly
85
+ BIWEEKLY = :biweekly
86
+ MONTHLY = :monthly
87
+ NEVER = :never
88
+
89
+ # @!method self.values
90
+ # @return [Array<Symbol>]
91
+ end
92
+
93
+ # Current enrollment status
94
+ #
95
+ # @see Telnyx::Models::Enterprises::ReputationListResponse::Data#status
96
+ module Status
97
+ extend Telnyx::Internal::Type::Enum
98
+
99
+ PENDING = :pending
100
+ APPROVED = :approved
101
+ REJECTED = :rejected
102
+ DELETED = :deleted
103
+
104
+ # @!method self.values
105
+ # @return [Array<Symbol>]
106
+ end
107
+ end
108
+ end
109
+ end
110
+ end
111
+ end