twilio-ruby 5.31.1 → 5.54.0

data/lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb

@@ -0,0 +1,226 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Bulkexports < Domain
+      class V1 < Version
+        class ExportConfigurationList < ListResource
+          ##
+          # Initialize the ExportConfigurationList
+          # @param [Version] version Version that contains the resource
+          # @return [ExportConfigurationList] ExportConfigurationList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Bulkexports.V1.ExportConfigurationList>'
+          end
+        end
+
+        class ExportConfigurationPage < Page
+          ##
+          # Initialize the ExportConfigurationPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ExportConfigurationPage] ExportConfigurationPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ExportConfigurationInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ExportConfigurationInstance] ExportConfigurationInstance
+          def get_instance(payload)
+            ExportConfigurationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Bulkexports.V1.ExportConfigurationPage>'
+          end
+        end
+
+        class ExportConfigurationContext < InstanceContext
+          ##
+          # Initialize the ExportConfigurationContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] resource_type The type of communication – Messages, Calls,
+          #   Conferences, and Participants
+          # @return [ExportConfigurationContext] ExportConfigurationContext
+          def initialize(version, resource_type)
+            super(version)
+
+            # Path Solution
+            @solution = {resource_type: resource_type, }
+            @uri = "/Exports/#{@solution[:resource_type]}/Configuration"
+          end
+
+          ##
+          # Fetch the ExportConfigurationInstance
+          # @return [ExportConfigurationInstance] Fetched ExportConfigurationInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            ExportConfigurationInstance.new(@version, payload, resource_type: @solution[:resource_type], )
+          end
+
+          ##
+          # Update the ExportConfigurationInstance
+          # @param [Boolean] enabled If true, Twilio will automatically generate every day's
+          #   file when the day is over.
+          # @param [String] webhook_url Stores the URL destination for the method specified
+          #   in webhook_method.
+          # @param [String] webhook_method Sets whether Twilio should call a webhook URL
+          #   when the automatic generation is complete, using GET or POST. The actual
+          #   destination is set in the webhook_url
+          # @return [ExportConfigurationInstance] Updated ExportConfigurationInstance
+          def update(enabled: :unset, webhook_url: :unset, webhook_method: :unset)
+            data = Twilio::Values.of({
+                'Enabled' => enabled,
+                'WebhookUrl' => webhook_url,
+                'WebhookMethod' => webhook_method,
+            })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            ExportConfigurationInstance.new(@version, payload, resource_type: @solution[:resource_type], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Bulkexports.V1.ExportConfigurationContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Bulkexports.V1.ExportConfigurationContext #{context}>"
+          end
+        end
+
+        class ExportConfigurationInstance < InstanceResource
+          ##
+          # Initialize the ExportConfigurationInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] resource_type The type of communication – Messages, Calls,
+          #   Conferences, and Participants
+          # @return [ExportConfigurationInstance] ExportConfigurationInstance
+          def initialize(version, payload, resource_type: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'enabled' => payload['enabled'],
+                'webhook_url' => payload['webhook_url'],
+                'webhook_method' => payload['webhook_method'],
+                'resource_type' => payload['resource_type'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'resource_type' => resource_type || @properties['resource_type'], }
+          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 [ExportConfigurationContext] ExportConfigurationContext for this ExportConfigurationInstance
+          def context
+            unless @instance_context
+              @instance_context = ExportConfigurationContext.new(@version, @params['resource_type'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [Boolean] Whether files are automatically generated
+          def enabled
+            @properties['enabled']
+          end
+
+          ##
+          # @return [String] URL targeted at export
+          def webhook_url
+            @properties['webhook_url']
+          end
+
+          ##
+          # @return [String] Whether to GET or POST to the webhook url
+          def webhook_method
+            @properties['webhook_method']
+          end
+
+          ##
+          # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
+          def resource_type
+            @properties['resource_type']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the ExportConfigurationInstance
+          # @return [ExportConfigurationInstance] Fetched ExportConfigurationInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the ExportConfigurationInstance
+          # @param [Boolean] enabled If true, Twilio will automatically generate every day's
+          #   file when the day is over.
+          # @param [String] webhook_url Stores the URL destination for the method specified
+          #   in webhook_method.
+          # @param [String] webhook_method Sets whether Twilio should call a webhook URL
+          #   when the automatic generation is complete, using GET or POST. The actual
+          #   destination is set in the webhook_url
+          # @return [ExportConfigurationInstance] Updated ExportConfigurationInstance
+          def update(enabled: :unset, webhook_url: :unset, webhook_method: :unset)
+            context.update(enabled: enabled, webhook_url: webhook_url, webhook_method: webhook_method, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Bulkexports.V1.ExportConfigurationInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Bulkexports.V1.ExportConfigurationInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -26,11 +26,12 @@ module Twilio
         # @return [Twilio::REST::Chat::V1::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @credentials ||= CredentialList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @credentials ||= CredentialList.new self
           else
-            CredentialContext.new(self, sid)
+              CredentialContext.new(self, sid)
           end
         end
 
@@ -41,11 +42,12 @@ module Twilio
         # @return [Twilio::REST::Chat::V1::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/chat/v1/credential.rb

@@ -84,11 +84,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             CredentialPage.new(@version, response, @solution)
           end
 
@@ -106,8 +104,7 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of CredentialInstance records from the API.
-          # Request is executed immediately.
+          # Create the CredentialInstance
           # @param [credential.PushService] type The type of push-notification service the
           #   credential is for. Can be: `gcm`, `fcm`, or `apn`.
           # @param [String] friendly_name A descriptive string that you create to describe
@@ -128,7 +125,7 @@ module Twilio
           #   from the Google Developer console for your GCM Service application credential.
           # @param [String] secret [FCM only] The **Server key** of your project from the
           #   Firebase console, found under Settings / Cloud messaging.
-          # @return [CredentialInstance] Newly created CredentialInstance
+          # @return [CredentialInstance] Created CredentialInstance
           def create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
             data = Twilio::Values.of({
                 'Type' => type,
@@ -140,11 +137,7 @@ module Twilio
                 'Secret' => secret,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             CredentialInstance.new(@version, payload, )
           end
@@ -201,16 +194,10 @@ module Twilio
           end
 
           ##
-          # Fetch a CredentialInstance
+          # Fetch the CredentialInstance
           # @return [CredentialInstance] Fetched CredentialInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             CredentialInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -246,20 +233,16 @@ module Twilio
                 'Secret' => secret,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             CredentialInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the CredentialInstance
+          # Delete the CredentialInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -365,7 +348,7 @@ module Twilio
           end
 
           ##
-          # Fetch a CredentialInstance
+          # Fetch the CredentialInstance
           # @return [CredentialInstance] Fetched CredentialInstance
           def fetch
             context.fetch
@@ -404,7 +387,7 @@ module Twilio
           end
 
           ##
-          # Deletes the CredentialInstance
+          # Delete the CredentialInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete

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

@@ -24,19 +24,14 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of ServiceInstance records from the API.
-          # Request is executed immediately.
+          # Create the ServiceInstance
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource. It can be up to 64 characters long.
-          # @return [ServiceInstance] Newly created ServiceInstance
+          # @return [ServiceInstance] Created ServiceInstance
           def create(friendly_name: nil)
             data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, )
           end
@@ -102,11 +97,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             ServicePage.new(@version, response, @solution)
           end
 
@@ -180,25 +173,19 @@ module Twilio
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the ServiceInstance
+          # Delete the ServiceInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -206,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
@@ -250,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.
-          # @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.
+          #   the default is `POST`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
+          # @param [Array[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.
           # @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.
@@ -405,11 +392,7 @@ module Twilio
                 'Limits.UserChannels' => limits_user_channels,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -638,7 +621,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The list of WebHook events that are enabled for this Service instance
+          # @return [Array[String]] The list of WebHook events that are enabled for this Service instance
           def webhook_filters
             @properties['webhook_filters']
           end
@@ -662,14 +645,14 @@ module Twilio
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the ServiceInstance
+          # Delete the ServiceInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
@@ -680,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
@@ -724,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.
-          # @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.
+          #   the default is `POST`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
+          # @param [Array[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.
           # @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.