twilio-ruby 5.31.1 → 5.46.1

data/lib/twilio-ruby/rest/verify/v2/service/webhook.rb

@@ -0,0 +1,408 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      class V2 < Version
+        class ServiceContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class WebhookList < ListResource
+            ##
+            # Initialize the WebhookList
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @return [WebhookList] WebhookList
+            def initialize(version, service_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {service_sid: service_sid}
+              @uri = "/Services/#{@solution[:service_sid]}/Webhooks"
+            end
+
+            ##
+            # Create the WebhookInstance
+            # @param [String] friendly_name The string that you assigned to describe the
+            #   webhook. **This value should not contain PII.**
+            # @param [Array[String]] event_types The array of events that this Webhook is
+            #   subscribed to. Possible event types: `*, factor.deleted, factor.created,
+            #   factor.verified, challenge.approved, challenge.denied`
+            # @param [String] webhook_url The URL associated with this Webhook.
+            # @param [webhook.Status] status The webhook status. Default value is `enabled`.
+            #   One of: `enabled` or `disabled`
+            # @return [WebhookInstance] Created WebhookInstance
+            def create(friendly_name: nil, event_types: nil, webhook_url: nil, status: :unset)
+              data = Twilio::Values.of({
+                  'FriendlyName' => friendly_name,
+                  'EventTypes' => Twilio.serialize_list(event_types) { |e| e },
+                  'WebhookUrl' => webhook_url,
+                  'Status' => status,
+              })
+
+              payload = @version.create('POST', @uri, data: data)
+
+              WebhookInstance.new(@version, payload, service_sid: @solution[:service_sid], )
+            end
+
+            ##
+            # Lists WebhookInstance 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()
+            #    guarantees to never return more than limit.  Default is no limit
+            # @param [Integer] page_size Number of records to fetch per request, when
+            #    not set will use the default value of 50 records.  If no page_size is defined
+            #    but a limit is defined, stream() will attempt to read the limit with the most
+            #    efficient page size, i.e. min(limit, 1000)
+            # @return [Array] Array of up to limit results
+            def list(limit: nil, page_size: nil)
+              self.stream(limit: limit, page_size: page_size).entries
+            end
+
+            ##
+            # Streams WebhookInstance 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()
+            #    guarantees to never return more than limit. Default is no limit.
+            # @param [Integer] page_size Number of records to fetch per request, when
+            #    not set will use the default value of 50 records. If no page_size is defined
+            #    but a limit is defined, stream() will attempt to read the limit with the most
+            #    efficient page size, i.e. min(limit, 1000)
+            # @return [Enumerable] Enumerable that will yield up to limit results
+            def stream(limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields WebhookInstance records from the API.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            def each
+              limits = @version.read_limits
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page,
+                              limit: limits[:limit],
+                              page_limit: limits[:page_limit]).each {|x| yield x}
+            end
+
+            ##
+            # Retrieve a single page of WebhookInstance 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 WebhookInstance
+            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: params)
+
+              WebhookPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of WebhookInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of WebhookInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              WebhookPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Verify.V2.WebhookList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class WebhookPage < Page
+            ##
+            # Initialize the WebhookPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [WebhookPage] WebhookPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of WebhookInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [WebhookInstance] WebhookInstance
+            def get_instance(payload)
+              WebhookInstance.new(@version, payload, service_sid: @solution[:service_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Verify.V2.WebhookPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class WebhookContext < InstanceContext
+            ##
+            # Initialize the WebhookContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Webhook resource to fetch.
+            # @return [WebhookContext] WebhookContext
+            def initialize(version, service_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {service_sid: service_sid, sid: sid, }
+              @uri = "/Services/#{@solution[:service_sid]}/Webhooks/#{@solution[:sid]}"
+            end
+
+            ##
+            # Update the WebhookInstance
+            # @param [String] friendly_name The string that you assigned to describe the
+            #   webhook. **This value should not contain PII.**
+            # @param [Array[String]] event_types The array of events that this Webhook is
+            #   subscribed to. Possible event types: `*, factor.deleted, factor.created,
+            #   factor.verified, challenge.approved, challenge.denied`
+            # @param [String] webhook_url The URL associated with this Webhook.
+            # @param [webhook.Status] status The webhook status. Default value is `enabled`.
+            #   One of: `enabled` or `disabled`
+            # @return [WebhookInstance] Updated WebhookInstance
+            def update(friendly_name: :unset, event_types: :unset, webhook_url: :unset, status: :unset)
+              data = Twilio::Values.of({
+                  'FriendlyName' => friendly_name,
+                  'EventTypes' => Twilio.serialize_list(event_types) { |e| e },
+                  'WebhookUrl' => webhook_url,
+                  'Status' => status,
+              })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              WebhookInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
+            end
+
+            ##
+            # Delete the WebhookInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+               @version.delete('DELETE', @uri)
+            end
+
+            ##
+            # Fetch the WebhookInstance
+            # @return [WebhookInstance] Fetched WebhookInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              WebhookInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Verify.V2.WebhookContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Verify.V2.WebhookContext #{context}>"
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class WebhookInstance < InstanceResource
+            ##
+            # Initialize the WebhookInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] service_sid The unique SID identifier of the Service.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Webhook resource to fetch.
+            # @return [WebhookInstance] WebhookInstance
+            def initialize(version, payload, service_sid: nil, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'service_sid' => payload['service_sid'],
+                  'account_sid' => payload['account_sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'event_types' => payload['event_types'],
+                  'status' => payload['status'],
+                  'webhook_url' => payload['webhook_url'],
+                  'webhook_method' => payload['webhook_method'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
+            end
+
+            ##
+            # Generate an instance context for the instance, the context is capable of
+            # performing various actions.  All instance actions are proxied to the context
+            # @return [WebhookContext] WebhookContext for this WebhookInstance
+            def context
+              unless @instance_context
+                @instance_context = WebhookContext.new(@version, @params['service_sid'], @params['sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique string that identifies the resource
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] Service Sid.
+            def service_sid
+              @properties['service_sid']
+            end
+
+            ##
+            # @return [String] The SID of the Account that created the resource
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The string that you assigned to describe the webhook
+            def friendly_name
+              @properties['friendly_name']
+            end
+
+            ##
+            # @return [Array[String]] The array of events that this Webhook is subscribed to.
+            def event_types
+              @properties['event_types']
+            end
+
+            ##
+            # @return [webhook.Status] The webhook status
+            def status
+              @properties['status']
+            end
+
+            ##
+            # @return [String] The URL associated with this Webhook.
+            def webhook_url
+              @properties['webhook_url']
+            end
+
+            ##
+            # @return [webhook.Methods] The method used when calling the webhook's URL.
+            def webhook_method
+              @properties['webhook_method']
+            end
+
+            ##
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # @return [String] The absolute URL of the Webhook resource
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Update the WebhookInstance
+            # @param [String] friendly_name The string that you assigned to describe the
+            #   webhook. **This value should not contain PII.**
+            # @param [Array[String]] event_types The array of events that this Webhook is
+            #   subscribed to. Possible event types: `*, factor.deleted, factor.created,
+            #   factor.verified, challenge.approved, challenge.denied`
+            # @param [String] webhook_url The URL associated with this Webhook.
+            # @param [webhook.Status] status The webhook status. Default value is `enabled`.
+            #   One of: `enabled` or `disabled`
+            # @return [WebhookInstance] Updated WebhookInstance
+            def update(friendly_name: :unset, event_types: :unset, webhook_url: :unset, status: :unset)
+              context.update(
+                  friendly_name: friendly_name,
+                  event_types: event_types,
+                  webhook_url: webhook_url,
+                  status: status,
+              )
+            end
+
+            ##
+            # Delete the WebhookInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Fetch the WebhookInstance
+            # @return [WebhookInstance] Fetched WebhookInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Verify.V2.WebhookInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Verify.V2.WebhookInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/video/v1/composition.rb

@@ -32,7 +32,7 @@ module Twilio
           # @param [composition.Status] status Read only Composition resources with this
           #   status. Can be: `enqueued`, `processing`, `completed`, `deleted`, or `failed`.
           # @param [Time] date_created_after Read only Composition resources created on or
-          #   after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with
+          #   after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with
           #   time zone.
           # @param [Time] date_created_before Read only Composition resources created before
           #   this ISO 8601 date-time with time zone.
@@ -62,7 +62,7 @@ module Twilio
           # @param [composition.Status] status Read only Composition resources with this
           #   status. Can be: `enqueued`, `processing`, `completed`, `deleted`, or `failed`.
           # @param [Time] date_created_after Read only Composition resources created on or
-          #   after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with
+          #   after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with
           #   time zone.
           # @param [Time] date_created_before Read only Composition resources created before
           #   this ISO 8601 date-time with time zone.
@@ -108,7 +108,7 @@ module Twilio
           # @param [composition.Status] status Read only Composition resources with this
           #   status. Can be: `enqueued`, `processing`, `completed`, `deleted`, or `failed`.
           # @param [Time] date_created_after Read only Composition resources created on or
-          #   after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with
+          #   after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time with
           #   time zone.
           # @param [Time] date_created_before Read only Composition resources created before
           #   this ISO 8601 date-time with time zone.
@@ -127,11 +127,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             CompositionPage.new(@version, response, @solution)
           end
 
@@ -149,26 +147,29 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of CompositionInstance records from the API.
-          # Request is executed immediately.
+          # Create the CompositionInstance
           # @param [String] room_sid The SID of the Group Room with the media tracks to be
           #   used as composition sources.
           # @param [Hash] video_layout An object that describes the video layout of the
-          #   composition in terms of regions. See [Specifying Video
-          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.
-          # @param [String] audio_sources An array of track names from the same group room
-          #   to merge into the new composition. Can include zero or more track names. The new
-          #   composition includes all audio sources specified in `audio_sources` except for
-          #   those specified in `audio_sources_excluded`. The track names in this parameter
-          #   can include an asterisk as a wild card character, which will match zero or more
-          #   characters in a track name. For example, `student*` includes `student` as well
-          #   as `studentTeam`.
-          # @param [String] audio_sources_excluded An array of track names to exclude. The
-          #   new composition includes all audio sources specified in `audio_sources` except
-          #   for those specified in `audio_sources_excluded`. The track names in this
+          #   composition in terms of regions. See {Specifying Video
+          #   Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts]
+          #   for more info. Please, be aware that either video_layout or audio_sources have
+          #   to be provided to get a valid creation request
+          # @param [Array[String]] audio_sources An array of track names from the same group
+          #   room to merge into the new composition. Can include zero or more track names.
+          #   The new composition includes all audio sources specified in `audio_sources`
+          #   except for those specified in `audio_sources_excluded`. The track names in this
           #   parameter can include an asterisk as a wild card character, which will match
-          #   zero or more characters in a track name. For example, `student*` excludes
-          #   `student` as well as `studentTeam`. This parameter can also be empty.
+          #   zero or more characters in a track name. For example, `student*` includes
+          #   `student` as well as `studentTeam`. Please, be aware that either video_layout or
+          #   audio_sources have to be provided to get a valid creation request
+          # @param [Array[String]] audio_sources_excluded An array of track names to
+          #   exclude. The new composition includes all audio sources specified in
+          #   `audio_sources` except for those specified in `audio_sources_excluded`. The
+          #   track names in this parameter can include an asterisk as a wild card character,
+          #   which will match zero or more characters in a track name. For example,
+          #   `student*` excludes `student` as well as `studentTeam`. This parameter can also
+          #   be empty.
           # @param [String] resolution A string that describes the columns (width) and rows
           #   (height) of the generated composed video in pixels. Defaults to `640x480`.
           #   The string's format is `{width}x{height}` where:
@@ -186,8 +187,9 @@ module Twilio
           #
           #   Note that the `resolution` imposes an aspect ratio to the resulting composition.
           #   When the original video tracks are constrained by the aspect ratio, they are
-          #   scaled to fit. See [Specifying Video
-          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.
+          #   scaled to fit. See {Specifying Video
+          #   Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts]
+          #   for more info.
           # @param [composition.Format] format The container format of the composition's
           #   media files. Can be: `mp4` or `webm` and the default is `webm`. If you specify
           #   `mp4` or `webm`, you must also specify one or more `audio_sources` and/or a
@@ -203,9 +205,10 @@ module Twilio
           #   media in the composition. The default is `true`. Compositions with `trim`
           #   enabled are shorter when the Room is created and no Participant joins for a
           #   while as well as if all the Participants leave the room and join later, because
-          #   those gaps will be removed. See [Specifying Video
-          #   Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.
-          # @return [CompositionInstance] Newly created CompositionInstance
+          #   those gaps will be removed. See {Specifying Video
+          #   Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts]
+          #   for more info.
+          # @return [CompositionInstance] Created CompositionInstance
           def create(room_sid: nil, video_layout: :unset, audio_sources: :unset, audio_sources_excluded: :unset, resolution: :unset, format: :unset, status_callback: :unset, status_callback_method: :unset, trim: :unset)
             data = Twilio::Values.of({
                 'RoomSid' => room_sid,
@@ -219,11 +222,7 @@ module Twilio
                 'Trim' => trim,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             CompositionInstance.new(@version, payload, )
           end
@@ -283,25 +282,19 @@ module Twilio
           end
 
           ##
-          # Fetch a CompositionInstance
+          # Fetch the CompositionInstance
           # @return [CompositionInstance] Fetched CompositionInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             CompositionInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the CompositionInstance
+          # Delete the CompositionInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -412,13 +405,13 @@ module Twilio
           end
 
           ##
-          # @return [String] The array of track names to include in the composition
+          # @return [Array[String]] The array of track names to include in the composition
           def audio_sources
             @properties['audio_sources']
           end
 
           ##
-          # @return [String] The array of track names to exclude from the composition
+          # @return [Array[String]] The array of track names to exclude from the composition
           def audio_sources_excluded
             @properties['audio_sources_excluded']
           end
@@ -478,14 +471,14 @@ module Twilio
           end
 
           ##
-          # Fetch a CompositionInstance
+          # Fetch the CompositionInstance
           # @return [CompositionInstance] Fetched CompositionInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the CompositionInstance
+          # Delete the CompositionInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete