bandwidth-sdk 14.0.0 → 14.1.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 (93) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +10 -10
  3. data/README.md +42 -10
  4. data/bandwidth.yml +1113 -0
  5. data/coverage/.last_run.json +1 -1
  6. data/coverage/.resultset.json +1204 -231
  7. data/coverage/index.html +20499 -10053
  8. data/custom_templates/README.mustache +6 -6
  9. data/docs/AdditionalDenialReason.md +22 -0
  10. data/docs/Address.md +30 -0
  11. data/docs/Contact.md +24 -0
  12. data/docs/Error.md +22 -0
  13. data/docs/FailureWebhook.md +28 -0
  14. data/docs/InitiateCallback.md +3 -1
  15. data/docs/LinksObject.md +24 -0
  16. data/docs/OptInWorkflow.md +20 -0
  17. data/docs/TelephoneNumber.md +18 -0
  18. data/docs/TfvBasicAuthentication.md +20 -0
  19. data/docs/{PublishPermissionsEnum.md → TfvCallbackStatusEnum.md} +2 -2
  20. data/docs/TfvError.md +22 -0
  21. data/docs/TfvStatus.md +32 -0
  22. data/docs/{DeviceApiVersionEnum.md → TfvStatusEnum.md} +2 -2
  23. data/docs/TfvSubmissionInfo.md +34 -0
  24. data/docs/TfvSubmissionWrapper.md +18 -0
  25. data/docs/TollFreeVerificationApi.md +585 -0
  26. data/docs/VerificationDenialWebhook.md +32 -0
  27. data/docs/VerificationRequest.md +36 -0
  28. data/docs/VerificationUpdateRequest.md +34 -0
  29. data/docs/VerificationWebhook.md +24 -0
  30. data/docs/WebhookSubscription.md +30 -0
  31. data/docs/WebhookSubscriptionBasicAuthentication.md +20 -0
  32. data/docs/WebhookSubscriptionRequestSchema.md +22 -0
  33. data/docs/WebhookSubscriptionTypeEnum.md +15 -0
  34. data/docs/WebhookSubscriptionsListBody.md +22 -0
  35. data/lib/bandwidth-sdk/api/toll_free_verification_api.rb +614 -0
  36. data/lib/bandwidth-sdk/configuration.rb +48 -0
  37. data/lib/bandwidth-sdk/models/additional_denial_reason.rb +254 -0
  38. data/lib/bandwidth-sdk/models/address.rb +501 -0
  39. data/lib/bandwidth-sdk/models/contact.rb +393 -0
  40. data/lib/bandwidth-sdk/models/error.rb +232 -0
  41. data/lib/bandwidth-sdk/models/failure_webhook.rb +304 -0
  42. data/lib/bandwidth-sdk/models/initiate_callback.rb +33 -4
  43. data/lib/bandwidth-sdk/models/links_object.rb +243 -0
  44. data/lib/bandwidth-sdk/models/opt_in_workflow.rb +265 -0
  45. data/lib/bandwidth-sdk/models/telephone_number.rb +213 -0
  46. data/lib/bandwidth-sdk/models/tfv_basic_authentication.rb +273 -0
  47. data/lib/bandwidth-sdk/models/tfv_callback_status_enum.rb +40 -0
  48. data/lib/bandwidth-sdk/models/tfv_error.rb +232 -0
  49. data/lib/bandwidth-sdk/models/tfv_status.rb +342 -0
  50. data/lib/bandwidth-sdk/models/tfv_status_enum.rb +43 -0
  51. data/lib/bandwidth-sdk/models/tfv_submission_info.rb +452 -0
  52. data/lib/bandwidth-sdk/models/tfv_submission_wrapper.rb +212 -0
  53. data/lib/bandwidth-sdk/models/verification_denial_webhook.rb +325 -0
  54. data/lib/bandwidth-sdk/models/verification_request.rb +547 -0
  55. data/lib/bandwidth-sdk/models/verification_update_request.rb +501 -0
  56. data/lib/bandwidth-sdk/models/verification_webhook.rb +303 -0
  57. data/lib/bandwidth-sdk/models/webhook_subscription.rb +328 -0
  58. data/lib/bandwidth-sdk/models/webhook_subscription_basic_authentication.rb +274 -0
  59. data/lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb +306 -0
  60. data/lib/bandwidth-sdk/models/webhook_subscription_type_enum.rb +40 -0
  61. data/lib/bandwidth-sdk/models/webhook_subscriptions_list_body.rb +242 -0
  62. data/lib/bandwidth-sdk/version.rb +1 -1
  63. data/lib/bandwidth-sdk.rb +25 -0
  64. data/openapi-config.yml +1 -1
  65. data/spec/call_utils.rb +2 -2
  66. data/spec/smoke/toll_free_verification_api_spec.rb +69 -0
  67. data/spec/spec_helper.rb +1 -1
  68. data/spec/unit/api/mfa_api_spec.rb +1 -1
  69. data/spec/unit/api/toll_free_verification_api_spec.rb +278 -0
  70. data/spec/unit/client/api_client_spec.rb +1 -1
  71. metadata +91 -61
  72. data/docs/CreateParticipantRequest.md +0 -24
  73. data/docs/CreateParticipantResponse.md +0 -20
  74. data/docs/DisconenctCallback.md +0 -50
  75. data/docs/ForbiddenRequest.md +0 -18
  76. data/docs/InboundMessageCallback.md +0 -26
  77. data/docs/InboundMessageCallbackMessage.md +0 -40
  78. data/docs/MessageDeliveredCallback.md +0 -26
  79. data/docs/MessageDeliveredCallbackMessage.md +0 -40
  80. data/docs/MessageFailedCallback.md +0 -28
  81. data/docs/MessageFailedCallbackMessage.md +0 -40
  82. data/docs/MessageSendingCallback.md +0 -26
  83. data/docs/MessageSendingCallbackMessage.md +0 -40
  84. data/docs/Participant.md +0 -30
  85. data/docs/ParticipantSubscription.md +0 -20
  86. data/docs/ParticipantsApi.md +0 -227
  87. data/docs/RequestError.md +0 -20
  88. data/docs/Session.md +0 -20
  89. data/docs/SessionsApi.md +0 -605
  90. data/docs/Subscriptions.md +0 -20
  91. data/docs/TranscriptionList.md +0 -18
  92. data/docs/TranscriptionMetadata.md +0 -24
  93. data/docs/UnauthorizedRequest.md +0 -18
@@ -0,0 +1,254 @@
1
+ =begin
2
+ #Bandwidth
3
+
4
+ #Bandwidth's Communication APIs
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: letstalk@bandwidth.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.8.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Bandwidth
17
+ class AdditionalDenialReason
18
+ # Reason code for denial.
19
+ attr_accessor :status_code
20
+
21
+ # Explanation for why a verification request was declined.
22
+ attr_accessor :reason
23
+
24
+ # Whether a Toll-Free Verification request qualifies for resubmission via PUT.
25
+ attr_accessor :resubmit_allowed
26
+
27
+ # Attribute mapping from ruby-style variable name to JSON key.
28
+ def self.attribute_map
29
+ {
30
+ :'status_code' => :'statusCode',
31
+ :'reason' => :'reason',
32
+ :'resubmit_allowed' => :'resubmitAllowed'
33
+ }
34
+ end
35
+
36
+ # Returns all the JSON keys this model knows about
37
+ def self.acceptable_attributes
38
+ attribute_map.values
39
+ end
40
+
41
+ # Attribute type mapping.
42
+ def self.openapi_types
43
+ {
44
+ :'status_code' => :'Integer',
45
+ :'reason' => :'String',
46
+ :'resubmit_allowed' => :'Boolean'
47
+ }
48
+ end
49
+
50
+ # List of attributes with nullable: true
51
+ def self.openapi_nullable
52
+ Set.new([
53
+ ])
54
+ end
55
+
56
+ # Initializes the object
57
+ # @param [Hash] attributes Model attributes in the form of hash
58
+ def initialize(attributes = {})
59
+ if (!attributes.is_a?(Hash))
60
+ fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::AdditionalDenialReason` initialize method'
61
+ end
62
+
63
+ # check to see if the attribute exists and convert string to symbol for hash key
64
+ attributes = attributes.each_with_object({}) { |(k, v), h|
65
+ if (!self.class.attribute_map.key?(k.to_sym))
66
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::AdditionalDenialReason`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
67
+ end
68
+ h[k.to_sym] = v
69
+ }
70
+
71
+ if attributes.key?(:'status_code')
72
+ self.status_code = attributes[:'status_code']
73
+ else
74
+ self.status_code = nil
75
+ end
76
+
77
+ if attributes.key?(:'reason')
78
+ self.reason = attributes[:'reason']
79
+ else
80
+ self.reason = nil
81
+ end
82
+
83
+ if attributes.key?(:'resubmit_allowed')
84
+ self.resubmit_allowed = attributes[:'resubmit_allowed']
85
+ else
86
+ self.resubmit_allowed = nil
87
+ end
88
+ end
89
+
90
+ # Show invalid properties with the reasons. Usually used together with valid?
91
+ # @return Array for valid properties with the reasons
92
+ def list_invalid_properties
93
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
94
+ invalid_properties = Array.new
95
+ if @status_code.nil?
96
+ invalid_properties.push('invalid value for "status_code", status_code cannot be nil.')
97
+ end
98
+
99
+ if @reason.nil?
100
+ invalid_properties.push('invalid value for "reason", reason cannot be nil.')
101
+ end
102
+
103
+ if @resubmit_allowed.nil?
104
+ invalid_properties.push('invalid value for "resubmit_allowed", resubmit_allowed cannot be nil.')
105
+ end
106
+
107
+ invalid_properties
108
+ end
109
+
110
+ # Check to see if the all the properties in the model are valid
111
+ # @return true if the model is valid
112
+ def valid?
113
+ warn '[DEPRECATED] the `valid?` method is obsolete'
114
+ return false if @status_code.nil?
115
+ return false if @reason.nil?
116
+ return false if @resubmit_allowed.nil?
117
+ true
118
+ end
119
+
120
+ # Checks equality by comparing each attribute.
121
+ # @param [Object] Object to be compared
122
+ def ==(o)
123
+ return true if self.equal?(o)
124
+ self.class == o.class &&
125
+ status_code == o.status_code &&
126
+ reason == o.reason &&
127
+ resubmit_allowed == o.resubmit_allowed
128
+ end
129
+
130
+ # @see the `==` method
131
+ # @param [Object] Object to be compared
132
+ def eql?(o)
133
+ self == o
134
+ end
135
+
136
+ # Calculates hash code according to all attributes.
137
+ # @return [Integer] Hash code
138
+ def hash
139
+ [status_code, reason, resubmit_allowed].hash
140
+ end
141
+
142
+ # Builds the object from hash
143
+ # @param [Hash] attributes Model attributes in the form of hash
144
+ # @return [Object] Returns the model itself
145
+ def self.build_from_hash(attributes)
146
+ return nil unless attributes.is_a?(Hash)
147
+ attributes = attributes.transform_keys(&:to_sym)
148
+ transformed_hash = {}
149
+ openapi_types.each_pair do |key, type|
150
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
151
+ transformed_hash["#{key}"] = nil
152
+ elsif type =~ /\AArray<(.*)>/i
153
+ # check to ensure the input is an array given that the attribute
154
+ # is documented as an array but the input is not
155
+ if attributes[attribute_map[key]].is_a?(Array)
156
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
157
+ end
158
+ elsif !attributes[attribute_map[key]].nil?
159
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
160
+ end
161
+ end
162
+ new(transformed_hash)
163
+ end
164
+
165
+ # Deserializes the data based on type
166
+ # @param string type Data type
167
+ # @param string value Value to be deserialized
168
+ # @return [Object] Deserialized data
169
+ def self._deserialize(type, value)
170
+ case type.to_sym
171
+ when :Time
172
+ Time.parse(value)
173
+ when :Date
174
+ Date.parse(value)
175
+ when :String
176
+ value.to_s
177
+ when :Integer
178
+ value.to_i
179
+ when :Float
180
+ value.to_f
181
+ when :Boolean
182
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
183
+ true
184
+ else
185
+ false
186
+ end
187
+ when :Object
188
+ # generic object (usually a Hash), return directly
189
+ value
190
+ when /\AArray<(?<inner_type>.+)>\z/
191
+ inner_type = Regexp.last_match[:inner_type]
192
+ value.map { |v| _deserialize(inner_type, v) }
193
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
194
+ k_type = Regexp.last_match[:k_type]
195
+ v_type = Regexp.last_match[:v_type]
196
+ {}.tap do |hash|
197
+ value.each do |k, v|
198
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
199
+ end
200
+ end
201
+ else # model
202
+ # models (e.g. Pet) or oneOf
203
+ klass = Bandwidth.const_get(type)
204
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
205
+ end
206
+ end
207
+
208
+ # Returns the string representation of the object
209
+ # @return [String] String presentation of the object
210
+ def to_s
211
+ to_hash.to_s
212
+ end
213
+
214
+ # to_body is an alias to to_hash (backward compatibility)
215
+ # @return [Hash] Returns the object in the form of hash
216
+ def to_body
217
+ to_hash
218
+ end
219
+
220
+ # Returns the object in the form of hash
221
+ # @return [Hash] Returns the object in the form of hash
222
+ def to_hash
223
+ hash = {}
224
+ self.class.attribute_map.each_pair do |attr, param|
225
+ value = self.send(attr)
226
+ if value.nil?
227
+ is_nullable = self.class.openapi_nullable.include?(attr)
228
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
229
+ end
230
+
231
+ hash[param] = _to_hash(value)
232
+ end
233
+ hash
234
+ end
235
+
236
+ # Outputs non-array value in the form of hash
237
+ # For object, use to_hash. Otherwise, just return the value
238
+ # @param [Object] value Any valid value
239
+ # @return [Hash] Returns the value in the form of hash
240
+ def _to_hash(value)
241
+ if value.is_a?(Array)
242
+ value.compact.map { |v| _to_hash(v) }
243
+ elsif value.is_a?(Hash)
244
+ {}.tap do |hash|
245
+ value.each { |k, v| hash[k] = _to_hash(v) }
246
+ end
247
+ elsif value.respond_to? :to_hash
248
+ value.to_hash
249
+ else
250
+ value
251
+ end
252
+ end
253
+ end
254
+ end