twilio-ruby 5.20.0 → 5.47.0

data/lib/twilio-ruby/rest/{preview/acc_security/service.rb → events/v1/sink.rb}

@@ -3,49 +3,51 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
   module REST
-    class Preview < Domain
-      class AccSecurity < Version
+    class Events < Domain
+      class V1 < Version
         ##
         # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class ServiceList < ListResource
+        class SinkList < ListResource
           ##
-          # Initialize the ServiceList
+          # Initialize the SinkList
           # @param [Version] version Version that contains the resource
-          # @return [ServiceList] ServiceList
+          # @return [SinkList] SinkList
           def initialize(version)
             super(version)
 
             # Path Solution
             @solution = {}
-            @uri = "/Services"
-          end
+            @uri = "/Sinks"
+          end
+
+          ##
+          # Create the SinkInstance
+          # @param [String] description A human readable description for the Sink **This
+          #   value should not contain PII.**
+          # @param [Hash] sink_configuration The information required for Twilio to connect
+          #   to the provided Sink encoded as JSON.
+          # @param [sink.SinkType] sink_type The Sink type. Can only be "kinesis" or
+          #   "webhook" currently.
+          # @return [SinkInstance] Created SinkInstance
+          def create(description: nil, sink_configuration: nil, sink_type: nil)
+            data = Twilio::Values.of({
+                'Description' => description,
+                'SinkConfiguration' => Twilio.serialize_object(sink_configuration),
+                'SinkType' => sink_type,
+            })
 
-          ##
-          # Retrieve a single page of ServiceInstance records from the API.
-          # Request is executed immediately.
-          # @param [String] name A 1-64 character string with friendly name of service
-          # @param [String] code_length The length of the verification code to be generated.
-          #   Must be an integer value between 4-10
-          # @return [ServiceInstance] Newly created ServiceInstance
-          def create(name: nil, code_length: :unset)
-            data = Twilio::Values.of({'Name' => name, 'CodeLength' => code_length, })
-
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
-            ServiceInstance.new(@version, payload, )
+            SinkInstance.new(@version, payload, )
           end
 
           ##
-          # Lists ServiceInstance records from the API as a list.
+          # Lists SinkInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -60,7 +62,7 @@ module Twilio
           end
 
           ##
-          # Streams ServiceInstance records from the API as an Enumerable.
+          # Streams SinkInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -79,7 +81,7 @@ module Twilio
           end
 
           ##
-          # When passed a block, yields ServiceInstance records from the API.
+          # When passed a block, yields SinkInstance records from the API.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
           def each
@@ -93,55 +95,53 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of ServiceInstance records from the API.
+          # Retrieve a single page of SinkInstance records from the API.
           # Request is executed immediately.
           # @param [String] page_token PageToken provided by the API
           # @param [Integer] page_number Page Number, this value is simply for client state
           # @param [Integer] page_size Number of records to return, defaults to 50
-          # @return [Page] Page of ServiceInstance
+          # @return [Page] Page of SinkInstance
           def page(page_token: :unset, page_number: :unset, page_size: :unset)
             params = Twilio::Values.of({
                 'PageToken' => page_token,
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
-            ServicePage.new(@version, response, @solution)
+
+            response = @version.page('GET', @uri, params: params)
+
+            SinkPage.new(@version, response, @solution)
           end
 
           ##
-          # Retrieve a single page of ServiceInstance records from the API.
+          # Retrieve a single page of SinkInstance records from the API.
           # Request is executed immediately.
           # @param [String] target_url API-generated URL for the requested results page
-          # @return [Page] Page of ServiceInstance
+          # @return [Page] Page of SinkInstance
           def get_page(target_url)
             response = @version.domain.request(
                 'GET',
                 target_url
             )
-            ServicePage.new(@version, response, @solution)
+            SinkPage.new(@version, response, @solution)
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '#<Twilio.Preview.AccSecurity.ServiceList>'
+            '#<Twilio.Events.V1.SinkList>'
           end
         end
 
         ##
         # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class ServicePage < Page
+        class SinkPage < Page
           ##
-          # Initialize the ServicePage
+          # Initialize the SinkPage
           # @param [Version] version Version that contains the resource
           # @param [Response] response Response from the API
           # @param [Hash] solution Path solution for the resource
-          # @return [ServicePage] ServicePage
+          # @return [SinkPage] SinkPage
           def initialize(version, response, solution)
             super(version, response)
 
@@ -150,125 +150,116 @@ module Twilio
           end
 
           ##
-          # Build an instance of ServiceInstance
+          # Build an instance of SinkInstance
           # @param [Hash] payload Payload response from the API
-          # @return [ServiceInstance] ServiceInstance
+          # @return [SinkInstance] SinkInstance
           def get_instance(payload)
-            ServiceInstance.new(@version, payload, )
+            SinkInstance.new(@version, payload, )
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '<Twilio.Preview.AccSecurity.ServicePage>'
+            '<Twilio.Events.V1.SinkPage>'
           end
         end
 
         ##
         # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class ServiceContext < InstanceContext
+        class SinkContext < InstanceContext
           ##
-          # Initialize the ServiceContext
+          # Initialize the SinkContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The unique SID identifier of Verification Service Instance.
-          # @return [ServiceContext] ServiceContext
+          # @param [String] sid A 34 character string that uniquely identifies this Sink.
+          # @return [SinkContext] SinkContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
             @solution = {sid: sid, }
-            @uri = "/Services/#{@solution[:sid]}"
+            @uri = "/Sinks/#{@solution[:sid]}"
 
             # Dependents
-            @verifications = nil
-            @verification_checks = nil
+            @sink_test = nil
+            @sink_validate = nil
           end
 
           ##
-          # Fetch a ServiceInstance
-          # @return [ServiceInstance] Fetched ServiceInstance
+          # Fetch the SinkInstance
+          # @return [SinkInstance] Fetched SinkInstance
           def fetch
-            params = Twilio::Values.of({})
+            payload = @version.fetch('GET', @uri)
 
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
-
-            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
+            SinkInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Update the ServiceInstance
-          # @param [String] name A 1-64 character string with friendly name of service
-          # @param [String] code_length The length of the verification code to be generated.
-          #   Must be an integer value between 4-10
-          # @return [ServiceInstance] Updated ServiceInstance
-          def update(name: :unset, code_length: :unset)
-            data = Twilio::Values.of({'Name' => name, 'CodeLength' => code_length, })
-
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
-
-            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
+          # Delete the SinkInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+             @version.delete('DELETE', @uri)
           end
 
           ##
-          # Access the verifications
-          # @return [VerificationList]
-          # @return [VerificationContext]
-          def verifications
-            unless @verifications
-              @verifications = VerificationList.new(@version, service_sid: @solution[:sid], )
+          # Access the sink_test
+          # @return [SinkTestList]
+          # @return [SinkTestContext]
+          def sink_test
+            unless @sink_test
+              @sink_test = SinkTestList.new(@version, sid: @solution[:sid], )
             end
 
-            @verifications
+            @sink_test
           end
 
           ##
-          # Access the verification_checks
-          # @return [VerificationCheckList]
-          # @return [VerificationCheckContext]
-          def verification_checks
-            unless @verification_checks
-              @verification_checks = VerificationCheckList.new(@version, service_sid: @solution[:sid], )
+          # Access the sink_validate
+          # @return [SinkValidateList]
+          # @return [SinkValidateContext]
+          def sink_validate
+            unless @sink_validate
+              @sink_validate = SinkValidateList.new(@version, sid: @solution[:sid], )
             end
 
-            @verification_checks
+            @sink_validate
           end
 
           ##
           # Provide a user friendly representation
           def to_s
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Preview.AccSecurity.ServiceContext #{context}>"
+            "#<Twilio.Events.V1.SinkContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Events.V1.SinkContext #{context}>"
           end
         end
 
         ##
         # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class ServiceInstance < InstanceResource
+        class SinkInstance < InstanceResource
           ##
-          # Initialize the ServiceInstance
+          # Initialize the SinkInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The unique SID identifier of Verification Service Instance.
-          # @return [ServiceInstance] ServiceInstance
+          # @param [String] sid A 34 character string that uniquely identifies this Sink.
+          # @return [SinkInstance] SinkInstance
           def initialize(version, payload, sid: nil)
             super(version)
 
             # Marshaled Properties
             @properties = {
-                'sid' => payload['sid'],
-                'account_sid' => payload['account_sid'],
-                'name' => payload['name'],
-                'code_length' => payload['code_length'].to_i,
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'description' => payload['description'],
+                'sid' => payload['sid'],
+                'sink_configuration' => payload['sink_configuration'],
+                'sink_type' => payload['sink_type'],
+                'status' => payload['status'],
                 'url' => payload['url'],
                 'links' => payload['links'],
             }
@@ -281,105 +272,108 @@ module Twilio
           ##
           # Generate an instance context for the instance, the context is capable of
           # performing various actions.  All instance actions are proxied to the context
-          # @return [ServiceContext] ServiceContext for this ServiceInstance
+          # @return [SinkContext] SinkContext for this SinkInstance
           def context
             unless @instance_context
-              @instance_context = ServiceContext.new(@version, @params['sid'], )
+              @instance_context = SinkContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
 
           ##
-          # @return [String] A string that uniquely identifies this Service.
-          def sid
-            @properties['sid']
+          # @return [Time] The date this Sink was created
+          def date_created
+            @properties['date_created']
           end
 
           ##
-          # @return [String] Account Sid.
-          def account_sid
-            @properties['account_sid']
+          # @return [Time] The date this Sink was updated
+          def date_updated
+            @properties['date_updated']
           end
 
           ##
-          # @return [String] Friendly name of the service
-          def name
-            @properties['name']
+          # @return [String] Sink Description
+          def description
+            @properties['description']
           end
 
           ##
-          # @return [String] Length of verification code. Valid values are 4-10
-          def code_length
-            @properties['code_length']
+          # @return [String] A string that uniquely identifies this Sink.
+          def sid
+            @properties['sid']
           end
 
           ##
-          # @return [Time] The date this Service was created
-          def date_created
-            @properties['date_created']
+          # @return [Hash] JSON Sink configuration.
+          def sink_configuration
+            @properties['sink_configuration']
           end
 
           ##
-          # @return [Time] The date this Service was updated
-          def date_updated
-            @properties['date_updated']
+          # @return [sink.SinkType] Sink type.
+          def sink_type
+            @properties['sink_type']
+          end
+
+          ##
+          # @return [sink.Status] The Status of this Sink
+          def status
+            @properties['status']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The URL of this resource.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] Nested resource URLs.
           def links
             @properties['links']
           end
 
           ##
-          # Fetch a ServiceInstance
-          # @return [ServiceInstance] Fetched ServiceInstance
+          # Fetch the SinkInstance
+          # @return [SinkInstance] Fetched SinkInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Update the ServiceInstance
-          # @param [String] name A 1-64 character string with friendly name of service
-          # @param [String] code_length The length of the verification code to be generated.
-          #   Must be an integer value between 4-10
-          # @return [ServiceInstance] Updated ServiceInstance
-          def update(name: :unset, code_length: :unset)
-            context.update(name: name, code_length: code_length, )
+          # Delete the SinkInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            context.delete
           end
 
           ##
-          # Access the verifications
-          # @return [verifications] verifications
-          def verifications
-            context.verifications
+          # Access the sink_test
+          # @return [sink_test] sink_test
+          def sink_test
+            context.sink_test
           end
 
           ##
-          # Access the verification_checks
-          # @return [verification_checks] verification_checks
-          def verification_checks
-            context.verification_checks
+          # Access the sink_validate
+          # @return [sink_validate] sink_validate
+          def sink_validate
+            context.sink_validate
           end
 
           ##
           # Provide a user friendly representation
           def to_s
             values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.AccSecurity.ServiceInstance #{values}>"
+            "<Twilio.Events.V1.SinkInstance #{values}>"
           end
 
           ##
           # Provide a detailed, user friendly representation
           def inspect
             values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.AccSecurity.ServiceInstance #{values}>"
+            "<Twilio.Events.V1.SinkInstance #{values}>"
           end
         end
       end