twilio-ruby 5.39.3 → 5.40.4

data/lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb

@@ -0,0 +1,216 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Events < Domain
+      class V1 < Version
+        class SubscriptionContext < InstanceContext
+          ##
+          # 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 SubscribedEventList < ListResource
+            ##
+            # Initialize the SubscribedEventList
+            # @param [Version] version Version that contains the resource
+            # @param [String] subscription_sid The unique SID identifier of the Subscription.
+            # @return [SubscribedEventList] SubscribedEventList
+            def initialize(version, subscription_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {subscription_sid: subscription_sid}
+              @uri = "/Subscriptions/#{@solution[:subscription_sid]}/SubscribedEvents"
+            end
+
+            ##
+            # Lists SubscribedEventInstance 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 SubscribedEventInstance 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 SubscribedEventInstance 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 SubscribedEventInstance 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 SubscribedEventInstance
+            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)
+
+              SubscribedEventPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of SubscribedEventInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of SubscribedEventInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              SubscribedEventPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Events.V1.SubscribedEventList>'
+            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 SubscribedEventPage < Page
+            ##
+            # Initialize the SubscribedEventPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [SubscribedEventPage] SubscribedEventPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of SubscribedEventInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SubscribedEventInstance] SubscribedEventInstance
+            def get_instance(payload)
+              SubscribedEventInstance.new(@version, payload, subscription_sid: @solution[:subscription_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Events.V1.SubscribedEventPage>'
+            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 SubscribedEventInstance < InstanceResource
+            ##
+            # Initialize the SubscribedEventInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] subscription_sid The unique SID identifier of the Subscription.
+            # @return [SubscribedEventInstance] SubscribedEventInstance
+            def initialize(version, payload, subscription_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'account_sid' => payload['account_sid'],
+                  'type' => payload['type'],
+                  'version' => payload['version'].to_i,
+                  'subscription_sid' => payload['subscription_sid'],
+                  'url' => payload['url'],
+              }
+            end
+
+            ##
+            # @return [String] Account SID.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] Type of event being subscribed to.
+            def type
+              @properties['type']
+            end
+
+            ##
+            # @return [String] The schema version that the subscription should use.
+            def version
+              @properties['version']
+            end
+
+            ##
+            # @return [String] Subscription SID.
+            def subscription_sid
+              @properties['subscription_sid']
+            end
+
+            ##
+            # @return [String] The URL of this resource.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Events.V1.SubscribedEventInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Events.V1.SubscribedEventInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/fax/v1/fax.rb

@@ -30,15 +30,15 @@ module Twilio
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
           # @param [String] from Retrieve only those faxes sent from this phone number,
-          #   specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format.
+          #   specified in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format.
           # @param [String] to Retrieve only those faxes sent to this phone number,
-          #   specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format.
+          #   specified in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format.
           # @param [Time] date_created_on_or_before Retrieve only those faxes with a
-          #   `date_created` that is before or equal to this value, specified in [ISO
-          #   8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+          #   `date_created` that is before or equal to this value, specified in {ISO
+          #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
           # @param [Time] date_created_after Retrieve only those faxes with a `date_created`
-          #   that is later than this value, specified in [ISO
-          #   8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+          #   that is later than this value, specified in {ISO
+          #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
           # @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
@@ -62,15 +62,15 @@ module Twilio
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
           # @param [String] from Retrieve only those faxes sent from this phone number,
-          #   specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format.
+          #   specified in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format.
           # @param [String] to Retrieve only those faxes sent to this phone number,
-          #   specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format.
+          #   specified in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format.
           # @param [Time] date_created_on_or_before Retrieve only those faxes with a
-          #   `date_created` that is before or equal to this value, specified in [ISO
-          #   8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+          #   `date_created` that is before or equal to this value, specified in {ISO
+          #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
           # @param [Time] date_created_after Retrieve only those faxes with a `date_created`
-          #   that is later than this value, specified in [ISO
-          #   8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+          #   that is later than this value, specified in {ISO
+          #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
           # @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
@@ -110,15 +110,15 @@ module Twilio
           # Retrieve a single page of FaxInstance records from the API.
           # Request is executed immediately.
           # @param [String] from Retrieve only those faxes sent from this phone number,
-          #   specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format.
+          #   specified in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format.
           # @param [String] to Retrieve only those faxes sent to this phone number,
-          #   specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format.
+          #   specified in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format.
           # @param [Time] date_created_on_or_before Retrieve only those faxes with a
-          #   `date_created` that is before or equal to this value, specified in [ISO
-          #   8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+          #   `date_created` that is before or equal to this value, specified in {ISO
+          #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
           # @param [Time] date_created_after Retrieve only those faxes with a `date_created`
-          #   that is later than this value, specified in [ISO
-          #   8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+          #   that is later than this value, specified in {ISO
+          #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
           # @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
@@ -155,20 +155,21 @@ module Twilio
           ##
           # Create the FaxInstance
           # @param [String] to The phone number to receive the fax in
-          #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format or the
+          #   {E.164}[https://www.twilio.com/docs/glossary/what-e164] format or the
           #   recipient's SIP URI.
           # @param [String] media_url The URL of the PDF that contains the fax. See our
-          #   [security](https://www.twilio.com/docs/usage/security) page for information on
+          #   {security}[https://www.twilio.com/docs/usage/security] page for information on
           #   how to ensure the request for your media comes from Twilio.
-          # @param [fax.Quality] quality The [Fax Quality
-          #   value](https://www.twilio.com/docs/fax/api/fax-resource#fax-quality-values) that
+          # @param [fax.Quality] quality The {Fax Quality
+          #   value}[https://www.twilio.com/docs/fax/api/fax-resource#fax-quality-values] that
           #   describes the fax quality. Can be: `standard`, `fine`, or `superfine` and
           #   defaults to `fine`.
           # @param [String] status_callback The URL we should call using the `POST` method
-          #   to send [status
-          #   information](https://www.twilio.com/docs/fax/api/fax-resource#fax-status-callback) to your application when the status of the fax changes.
+          #   to send {status
+          #   information}[https://www.twilio.com/docs/fax/api/fax-resource#fax-status-callback]
+          #   to your application when the status of the fax changes.
           # @param [String] from The number the fax was sent from. Can be the phone number
-          #   in [E.164](https://www.twilio.com/docs/glossary/what-e164) format or the SIP
+          #   in {E.164}[https://www.twilio.com/docs/glossary/what-e164] format or the SIP
           #   `from` value. The caller ID displayed to the recipient uses this value. If this
           #   is a phone number, it must be a Twilio number or a verified outgoing caller id
           #   from your account. If `to` is a SIP address, this can be any alphanumeric string
@@ -272,7 +273,7 @@ module Twilio
           ##
           # Update the FaxInstance
           # @param [fax.UpdateStatus] status The new
-          #   [status](https://www.twilio.com/docs/fax/api/fax-resource#fax-status-values) of
+          #   {status}[https://www.twilio.com/docs/fax/api/fax-resource#fax-status-values] of
           #   the resource. Can be only `canceled`. This may fail if transmission has already
           #   started.
           # @return [FaxInstance] Updated FaxInstance
@@ -493,7 +494,7 @@ module Twilio
           ##
           # Update the FaxInstance
           # @param [fax.UpdateStatus] status The new
-          #   [status](https://www.twilio.com/docs/fax/api/fax-resource#fax-status-values) of
+          #   {status}[https://www.twilio.com/docs/fax/api/fax-resource#fax-status-values] of
           #   the resource. Can be only `canceled`. This may fail if transmission has already
           #   started.
           # @return [FaxInstance] Updated FaxInstance

data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb

@@ -193,19 +193,19 @@ module Twilio
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource. It can be up to 64 characters long.
           # @param [String] default_service_role_sid The service role assigned to users when
-          #   they are added to the service. See the [Roles
-          #   endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
+          #   they are added to the service. See the {Roles
+          #   endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
           # @param [String] default_channel_role_sid The channel role assigned to users when
-          #   they are added to a channel. See the [Roles
-          #   endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
+          #   they are added to a channel. See the {Roles
+          #   endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
           # @param [String] default_channel_creator_role_sid The channel role assigned to a
-          #   channel creator when they join a new channel. See the [Roles
-          #   endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
-          # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
-          #   Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
+          #   channel creator when they join a new channel. See the {Roles
+          #   endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
+          # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
+          #   Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
           #   default is `true`.
-          # @param [Boolean] reachability_enabled Whether to enable the [Reachability
-          #   Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this
+          # @param [Boolean] reachability_enabled Whether to enable the {Reachability
+          #   Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
           #   Service instance. The default is `false`.
           # @param [String] typing_indicator_timeout How long in seconds after a `started
           #   typing` event until clients should assume that user is no longer typing, even if
@@ -237,18 +237,18 @@ module Twilio
           #   create the notification text displayed when a user is invited to a channel and
           #   `notifications.invited_to_channel.enabled` is `true`.
           # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
-          #   by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
+          #   by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details.
           # @param [String] post_webhook_url The URL for post-event webhooks, which are
-          #   called by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
+          #   called by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details.
           # @param [String] webhook_method The HTTP method to use for calls to the
           #   `pre_webhook_url` and `post_webhook_url` webhooks.  Can be: `POST` or `GET` and
-          #   the default is `POST`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   the default is `POST`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] webhook_filters The list of WebHook events that are enabled for
-          #   this Service instance. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   this Service instance. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] webhooks_on_message_send_url The URL of the webhook to call in
           #   response to the `on_message_send` event using the
           #   `webhooks.on_message_send.method` HTTP method.
@@ -663,19 +663,19 @@ module Twilio
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource. It can be up to 64 characters long.
           # @param [String] default_service_role_sid The service role assigned to users when
-          #   they are added to the service. See the [Roles
-          #   endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
+          #   they are added to the service. See the {Roles
+          #   endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
           # @param [String] default_channel_role_sid The channel role assigned to users when
-          #   they are added to a channel. See the [Roles
-          #   endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
+          #   they are added to a channel. See the {Roles
+          #   endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
           # @param [String] default_channel_creator_role_sid The channel role assigned to a
-          #   channel creator when they join a new channel. See the [Roles
-          #   endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
-          # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
-          #   Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
+          #   channel creator when they join a new channel. See the {Roles
+          #   endpoint}[https://www.twilio.com/docs/chat/api/roles] for more details.
+          # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
+          #   Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
           #   default is `true`.
-          # @param [Boolean] reachability_enabled Whether to enable the [Reachability
-          #   Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this
+          # @param [Boolean] reachability_enabled Whether to enable the {Reachability
+          #   Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
           #   Service instance. The default is `false`.
           # @param [String] typing_indicator_timeout How long in seconds after a `started
           #   typing` event until clients should assume that user is no longer typing, even if
@@ -707,18 +707,18 @@ module Twilio
           #   create the notification text displayed when a user is invited to a channel and
           #   `notifications.invited_to_channel.enabled` is `true`.
           # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
-          #   by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
+          #   by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details.
           # @param [String] post_webhook_url The URL for post-event webhooks, which are
-          #   called by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
+          #   called by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/api/chat/webhooks] for more details.
           # @param [String] webhook_method The HTTP method to use for calls to the
           #   `pre_webhook_url` and `post_webhook_url` webhooks.  Can be: `POST` or `GET` and
-          #   the default is `POST`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   the default is `POST`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] webhook_filters The list of WebHook events that are enabled for
-          #   this Service instance. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   this Service instance. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] webhooks_on_message_send_url The URL of the webhook to call in
           #   response to the `on_message_send` event using the
           #   `webhooks.on_message_send.method` HTTP method.

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the ChannelList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+            #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is
             #   associated with.
             # @return [ChannelList] ChannelList
             def initialize(version, service_sid: nil)
@@ -181,7 +181,7 @@ module Twilio
             # Initialize the ChannelContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the
+            #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] to fetch the
             #   resource from.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   Channel resource to fetch.
@@ -325,7 +325,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+            #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is
             #   associated with.
             # @param [String] sid The Twilio-provided string that uniquely identifies the
             #   Channel resource to fetch.