twilio-ruby 5.9.0 → 5.10.0

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

@@ -0,0 +1,432 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class IpMessaging < Domain
+      class V2 < Version
+        class ServiceContext < InstanceContext
+          class ChannelContext < InstanceContext
+            class WebhookList < ListResource
+              ##
+              # Initialize the WebhookList
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The service_sid
+              # @param [String] channel_sid The channel_sid
+              # @return [WebhookList] WebhookList
+              def initialize(version, service_sid: nil, channel_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {service_sid: service_sid, channel_sid: channel_sid}
+                @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Webhooks"
+              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
+                )
+                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
+
+              ##
+              # Retrieve a single page of WebhookInstance records from the API.
+              # Request is executed immediately.
+              # @param [webhook.Type] type The type
+              # @param [String] configuration_url The configuration.url
+              # @param [webhook.Method] configuration_method The configuration.method
+              # @param [String] configuration_filters The configuration.filters
+              # @param [String] configuration_triggers The configuration.triggers
+              # @param [String] configuration_flow_sid The configuration.flow_sid
+              # @param [String] configuration_retry_count The configuration.retry_count
+              # @return [WebhookInstance] Newly created WebhookInstance
+              def create(type: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset)
+                data = Twilio::Values.of({
+                    'Type' => type,
+                    'Configuration.Url' => configuration_url,
+                    'Configuration.Method' => configuration_method,
+                    'Configuration.Filters' => Twilio.serialize_list(configuration_filters) { |e| e },
+                    'Configuration.Triggers' => Twilio.serialize_list(configuration_triggers) { |e| e },
+                    'Configuration.FlowSid' => configuration_flow_sid,
+                    'Configuration.RetryCount' => configuration_retry_count,
+                })
+
+                payload = @version.create(
+                    'POST',
+                    @uri,
+                    data: data
+                )
+
+                WebhookInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    channel_sid: @solution[:channel_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.IpMessaging.V2.WebhookList>'
+              end
+            end
+
+            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],
+                    channel_sid: @solution[:channel_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.IpMessaging.V2.WebhookPage>'
+              end
+            end
+
+            class WebhookContext < InstanceContext
+              ##
+              # Initialize the WebhookContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The service_sid
+              # @param [String] channel_sid The channel_sid
+              # @param [String] sid The sid
+              # @return [WebhookContext] WebhookContext
+              def initialize(version, service_sid, channel_sid, sid)
+                super(version)
+
+                # Path Solution
+                @solution = {service_sid: service_sid, channel_sid: channel_sid, sid: sid, }
+                @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Webhooks/#{@solution[:sid]}"
+              end
+
+              ##
+              # Fetch a WebhookInstance
+              # @return [WebhookInstance] Fetched WebhookInstance
+              def fetch
+                params = Twilio::Values.of({})
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                WebhookInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    channel_sid: @solution[:channel_sid],
+                    sid: @solution[:sid],
+                )
+              end
+
+              ##
+              # Update the WebhookInstance
+              # @param [String] configuration_url The configuration.url
+              # @param [webhook.Method] configuration_method The configuration.method
+              # @param [String] configuration_filters The configuration.filters
+              # @param [String] configuration_triggers The configuration.triggers
+              # @param [String] configuration_flow_sid The configuration.flow_sid
+              # @param [String] configuration_retry_count The configuration.retry_count
+              # @return [WebhookInstance] Updated WebhookInstance
+              def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset)
+                data = Twilio::Values.of({
+                    'Configuration.Url' => configuration_url,
+                    'Configuration.Method' => configuration_method,
+                    'Configuration.Filters' => Twilio.serialize_list(configuration_filters) { |e| e },
+                    'Configuration.Triggers' => Twilio.serialize_list(configuration_triggers) { |e| e },
+                    'Configuration.FlowSid' => configuration_flow_sid,
+                    'Configuration.RetryCount' => configuration_retry_count,
+                })
+
+                payload = @version.update(
+                    'POST',
+                    @uri,
+                    data: data,
+                )
+
+                WebhookInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    channel_sid: @solution[:channel_sid],
+                    sid: @solution[:sid],
+                )
+              end
+
+              ##
+              # Deletes the WebhookInstance
+              # @return [Boolean] true if delete succeeds, true otherwise
+              def delete
+                @version.delete('delete', @uri)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.IpMessaging.V2.WebhookContext #{context}>"
+              end
+            end
+
+            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 service_sid
+              # @param [String] channel_sid The channel_sid
+              # @param [String] sid The sid
+              # @return [WebhookInstance] WebhookInstance
+              def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'sid' => payload['sid'],
+                    'account_sid' => payload['account_sid'],
+                    'service_sid' => payload['service_sid'],
+                    'channel_sid' => payload['channel_sid'],
+                    'type' => payload['type'],
+                    'url' => payload['url'],
+                    'configuration' => payload['configuration'],
+                    'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                    'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {
+                    'service_sid' => service_sid,
+                    'channel_sid' => channel_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['channel_sid'],
+                      @params['sid'],
+                  )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The sid
+              def sid
+                @properties['sid']
+              end
+
+              ##
+              # @return [String] The account_sid
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The service_sid
+              def service_sid
+                @properties['service_sid']
+              end
+
+              ##
+              # @return [String] The channel_sid
+              def channel_sid
+                @properties['channel_sid']
+              end
+
+              ##
+              # @return [String] The type
+              def type
+                @properties['type']
+              end
+
+              ##
+              # @return [String] The url
+              def url
+                @properties['url']
+              end
+
+              ##
+              # @return [Hash] The configuration
+              def configuration
+                @properties['configuration']
+              end
+
+              ##
+              # @return [Time] The date_created
+              def date_created
+                @properties['date_created']
+              end
+
+              ##
+              # @return [Time] The date_updated
+              def date_updated
+                @properties['date_updated']
+              end
+
+              ##
+              # Fetch a WebhookInstance
+              # @return [WebhookInstance] Fetched WebhookInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Update the WebhookInstance
+              # @param [String] configuration_url The configuration.url
+              # @param [webhook.Method] configuration_method The configuration.method
+              # @param [String] configuration_filters The configuration.filters
+              # @param [String] configuration_triggers The configuration.triggers
+              # @param [String] configuration_flow_sid The configuration.flow_sid
+              # @param [String] configuration_retry_count The configuration.retry_count
+              # @return [WebhookInstance] Updated WebhookInstance
+              def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset)
+                context.update(
+                    configuration_url: configuration_url,
+                    configuration_method: configuration_method,
+                    configuration_filters: configuration_filters,
+                    configuration_triggers: configuration_triggers,
+                    configuration_flow_sid: configuration_flow_sid,
+                    configuration_retry_count: configuration_retry_count,
+                )
+              end
+
+              ##
+              # Deletes the WebhookInstance
+              # @return [Boolean] true if delete succeeds, true otherwise
+              def delete
+                context.delete
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.IpMessaging.V2.WebhookInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.IpMessaging.V2.WebhookInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb

@@ -15,7 +15,9 @@ module Twilio
             ##
             # Initialize the ChannelList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The unique id of the
+            #   [Service](https://www.twilio.com/docs/chat/api/services) this channel belongs
+            #   to.
             # @return [ChannelList] ChannelList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,13 +30,24 @@ module Twilio
             ##
             # Retrieve a single page of ChannelInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
-            # @param [channel.ChannelType] type The type
-            # @param [Time] date_created The date_created
-            # @param [Time] date_updated The date_updated
-            # @param [String] created_by The created_by
+            # @param [String] friendly_name A human-readable name for the Channel. Optional.
+            # @param [String] unique_name A unique, addressable name for the Channel. 
+            #   Optional.
+            # @param [String] attributes An optional metadata field you can use to store any
+            #   data you wish. No processing or validation is done on this field.
+            # @param [channel.ChannelType] type The visibility of the channel - `public` or
+            #   `private`. Defaults to `public`.
+            # @param [Time] date_created The optional ISO8601 time specifying the datetime the
+            #   Channel should be set as being created.  Will be set to the current time by the
+            #   Chat service if not specified.  Note that this should only be used in cases
+            #   where a a Channel is being recreated from a backup/separate source
+            # @param [Time] date_updated The optional ISO8601 time specifying the datetime the
+            #   Channel should be set as having been last updated.  Will be set to the `null` by
+            #   the Chat service if not specified.  Note that this should only be used in cases
+            #   where a Channel is being recreated from a backup/separate source  and where a
+            #   Message was previously updated.
+            # @param [String] created_by Optional field to specify the Identity of the User
+            #   that created the Channel.  Will be set to "system" if not specified.
             # @return [ChannelInstance] Newly created ChannelInstance
             def create(friendly_name: :unset, unique_name: :unset, attributes: :unset, type: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
               data = Twilio::Values.of({
@@ -196,6 +209,7 @@ module Twilio
               @members = nil
               @messages = nil
               @invites = nil
+              @webhooks = nil
             end
 
             ##
@@ -222,12 +236,17 @@ module Twilio
 
             ##
             # Update the ChannelInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
-            # @param [Time] date_created The date_created
-            # @param [Time] date_updated The date_updated
-            # @param [String] created_by The created_by
+            # @param [String] friendly_name A human-readable name for the Channel. Optional.
+            # @param [String] unique_name A unique, addressable name for the Channel. 
+            #   Optional.
+            # @param [String] attributes An optional metadata field you can use to store any
+            #   data you wish. No processing or validation is done on this field.
+            # @param [Time] date_created The optional ISO8601 time specifying the datetime the
+            #   Channel should be set as being created.
+            # @param [Time] date_updated The optional ISO8601 time specifying the datetime the
+            #   Channel should be set as having been last updated.
+            # @param [String] created_by Optional field to specify the Identity of the User
+            #   that created the Channel.
             # @return [ChannelInstance] Updated ChannelInstance
             def update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
               data = Twilio::Values.of({
@@ -314,6 +333,28 @@ module Twilio
               @invites
             end
 
+            ##
+            # Access the webhooks
+            # @return [WebhookList]
+            # @return [WebhookContext] if sid was passed.
+            def webhooks(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return WebhookContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
+              end
+
+              unless @webhooks
+                @webhooks = WebhookList.new(
+                    @version,
+                    service_sid: @solution[:service_sid],
+                    channel_sid: @solution[:sid],
+                )
+              end
+
+              @webhooks
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -327,7 +368,9 @@ module Twilio
             # Initialize the ChannelInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The unique id of the
+            #   [Service](https://www.twilio.com/docs/chat/api/services) this channel belongs
+            #   to.
             # @param [String] sid The sid
             # @return [ChannelInstance] ChannelInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -368,85 +411,85 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A 34 character string that uniquely identifies this resource.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The unique id of the Account responsible for this channel.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The unique id of the Service this channel belongs to.
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The human-readable name of this channel.
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The unique_name
+            # @return [String] The unique, addressable name of this channel.
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] The attributes
+            # @return [String] An optional string metadata field you can use to store any data you wish.
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [channel.ChannelType] The type
+            # @return [channel.ChannelType] The visibility of this channel - either public or private
             def type
               @properties['type']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date that this resource was created.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date that this resource was last updated.
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The created_by
+            # @return [String] Identity of the channel's creator.
             def created_by
               @properties['created_by']
             end
 
             ##
-            # @return [String] The members_count
+            # @return [String] The number of Members in the Channel
             def members_count
               @properties['members_count']
             end
 
             ##
-            # @return [String] The messages_count
+            # @return [String] The number of Messages in the Channel
             def messages_count
               @properties['messages_count']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] An absolute URL for this channel.
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] Absolute URLs to access the Members, Messages , Invites and, if it exists the last Message for this Channel.
             def links
               @properties['links']
             end
@@ -467,12 +510,17 @@ module Twilio
 
             ##
             # Update the ChannelInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
-            # @param [Time] date_created The date_created
-            # @param [Time] date_updated The date_updated
-            # @param [String] created_by The created_by
+            # @param [String] friendly_name A human-readable name for the Channel. Optional.
+            # @param [String] unique_name A unique, addressable name for the Channel. 
+            #   Optional.
+            # @param [String] attributes An optional metadata field you can use to store any
+            #   data you wish. No processing or validation is done on this field.
+            # @param [Time] date_created The optional ISO8601 time specifying the datetime the
+            #   Channel should be set as being created.
+            # @param [Time] date_updated The optional ISO8601 time specifying the datetime the
+            #   Channel should be set as having been last updated.
+            # @param [String] created_by Optional field to specify the Identity of the User
+            #   that created the Channel.
             # @return [ChannelInstance] Updated ChannelInstance
             def update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
               context.update(
@@ -506,6 +554,13 @@ module Twilio
               context.invites
             end
 
+            ##
+            # Access the webhooks
+            # @return [webhooks] webhooks
+            def webhooks
+              context.webhooks
+            end
+
             ##
             # Provide a user friendly representation
             def to_s