twilio-ruby 5.19.0 → 5.77.0

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

@@ -0,0 +1,62 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Bulkexports
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Bulkexports
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @exports = nil
+          @export_configuration = nil
+        end
+
+        ##
+        # @param [String] resource_type The type of communication – Messages, Calls,
+        #   Conferences, and Participants
+        # @return [Twilio::REST::Bulkexports::V1::ExportContext] if resource_type was passed.
+        # @return [Twilio::REST::Bulkexports::V1::ExportList]
+        def exports(resource_type=:unset)
+          if resource_type.nil?
+              raise ArgumentError, 'resource_type cannot be nil'
+          end
+          if resource_type == :unset
+              @exports ||= ExportList.new self
+          else
+              ExportContext.new(self, resource_type)
+          end
+        end
+
+        ##
+        # @param [String] resource_type The type of communication – Messages, Calls,
+        #   Conferences, and Participants
+        # @return [Twilio::REST::Bulkexports::V1::ExportConfigurationContext] if resource_type was passed.
+        # @return [Twilio::REST::Bulkexports::V1::ExportConfigurationList]
+        def export_configuration(resource_type=:unset)
+          if resource_type.nil?
+              raise ArgumentError, 'resource_type cannot be nil'
+          end
+          if resource_type == :unset
+              @export_configuration ||= ExportConfigurationList.new self
+          else
+              ExportConfigurationContext.new(self, resource_type)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Bulkexports::V1>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Bulkexports < Domain
+      ##
+      # Initialize the Bulkexports Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://bulkexports.twilio.com'
+        @host = 'bulkexports.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of bulkexports
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @param [String] resource_type The type of communication – Messages, Calls,
+      #   Conferences, and Participants
+      # @return [Twilio::REST::Bulkexports::V1::ExportInstance] if resource_type was passed.
+      # @return [Twilio::REST::Bulkexports::V1::ExportList]
+      def exports(resource_type=:unset)
+        self.v1.exports(resource_type)
+      end
+
+      ##
+      # @param [String] resource_type The type of communication – Messages, Calls,
+      #   Conferences, and Participants
+      # @return [Twilio::REST::Bulkexports::V1::ExportConfigurationInstance] if resource_type was passed.
+      # @return [Twilio::REST::Bulkexports::V1::ExportConfigurationList]
+      def export_configuration(resource_type=:unset)
+        self.v1.export_configuration(resource_type)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Bulkexports>'
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -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,22 +104,28 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of CredentialInstance records from the API.
-          # Request is executed immediately.
-          # @param [credential.PushService] type Credential type, one of "gcm" or "apn"
-          # @param [String] friendly_name Friendly name for stored credential
-          # @param [String] certificate [APN only] URL encoded representation of the
-          #   certificate, e.g. `-----BEGIN
-          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
-          # @param [String] private_key [APN only] URL encoded representation of the private
-          #   key, e.g. `-----BEGIN RSA PRIVATE
-          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
-          # @param [Boolean] sandbox [APN only] use this credential for sending to
-          #   production or sandbox APNs (string `true` or `false`)
-          # @param [String] api_key [GCM only] This is the "API key" for project from Google
-          #   Developer console for your GCM Service application credential
-          # @param [String] secret The secret
-          # @return [CredentialInstance] Newly created CredentialInstance
+          # 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
+          #   the new resource. It can be up to 64 characters long.
+          # @param [String] certificate [APN only] The URL encoded representation of the
+          #   certificate. For example,
+          #   `-----BEGIN CERTIFICATE-----
+          #   MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==
+          #   -----END CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL encoded representation of the
+          #   private key. For example,
+          #   `-----BEGIN RSA PRIVATE KEY-----
+          #   MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.
+          #   -----END RSA PRIVATE KEY-----`
+          # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
+          #   APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
+          # @param [String] api_key [GCM only] The API key for the project that was obtained
+          #   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] 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,
@@ -133,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
@@ -182,7 +182,8 @@ module Twilio
           ##
           # Initialize the CredentialContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The Twilio-provided string that uniquely identifies the
+          #   Credential resource to fetch.
           # @return [CredentialContext] CredentialContext
           def initialize(version, sid)
             super(version)
@@ -193,34 +194,34 @@ 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
 
           ##
           # Update the CredentialInstance
-          # @param [String] friendly_name Friendly name for stored credential
-          # @param [String] certificate [APN only] URL encoded representation of the
-          #   certificate, e.g. `-----BEGIN
-          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
-          # @param [String] private_key [APN only] URL encoded representation of the private
-          #   key, e.g. `-----BEGIN RSA PRIVATE
-          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
-          # @param [Boolean] sandbox [APN only] use this credential for sending to
-          #   production or sandbox APNs (string `true` or `false`)
-          # @param [String] api_key [GCM only] This is the "API key" for project from Google
-          #   Developer console for your GCM Service application credential
-          # @param [String] secret The secret
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It can be up to 64 characters long.
+          # @param [String] certificate [APN only] The URL encoded representation of the
+          #   certificate. For example,
+          #   `-----BEGIN CERTIFICATE-----
+          #   MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==
+          #   -----END CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL encoded representation of the
+          #   private key. For example,
+          #   `-----BEGIN RSA PRIVATE KEY-----
+          #   MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.
+          #   -----END RSA PRIVATE KEY-----`
+          # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
+          #   APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
+          # @param [String] api_key [GCM only] The API key for the project that was obtained
+          #   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] Updated CredentialInstance
           def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
             data = Twilio::Values.of({
@@ -232,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
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the CredentialInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -254,6 +251,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Chat.V1.CredentialContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Chat.V1.CredentialContext #{context}>"
+          end
         end
 
         class CredentialInstance < InstanceResource
@@ -261,7 +265,8 @@ module Twilio
           # Initialize the CredentialInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The sid
+          # @param [String] sid The Twilio-provided string that uniquely identifies the
+          #   Credential resource to fetch.
           # @return [CredentialInstance] CredentialInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -295,55 +300,55 @@ module Twilio
           end
 
           ##
-          # @return [String] A 34 character string that uniquely identifies this resource.
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The unique id of the Account[/console] responsible for this resource.
+          # @return [String] The SID of the Account that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The human-readable name of this resource.
+          # @return [String] The string that you assigned to describe the resource
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [credential.PushService] Indicates which push notifications service this credential is for - either gcm or apn
+          # @return [credential.PushService] The type of push-notification service the credential is for
           def type
             @properties['type']
           end
 
           ##
-          # @return [String] [APN only] true when this resource should use the sandbox APN service.
+          # @return [String] [APN only] Whether to send the credential to sandbox APNs
           def sandbox
             @properties['sandbox']
           end
 
           ##
-          # @return [Time] The date that this resource was created.
+          # @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 date that this resource was last updated.
+          # @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] An absolute URL for this credential resource.
+          # @return [String] The absolute URL of the Credential resource
           def url
             @properties['url']
           end
 
           ##
-          # Fetch a CredentialInstance
+          # Fetch the CredentialInstance
           # @return [CredentialInstance] Fetched CredentialInstance
           def fetch
             context.fetch
@@ -351,18 +356,24 @@ module Twilio
 
           ##
           # Update the CredentialInstance
-          # @param [String] friendly_name Friendly name for stored credential
-          # @param [String] certificate [APN only] URL encoded representation of the
-          #   certificate, e.g. `-----BEGIN
-          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
-          # @param [String] private_key [APN only] URL encoded representation of the private
-          #   key, e.g. `-----BEGIN RSA PRIVATE
-          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
-          # @param [Boolean] sandbox [APN only] use this credential for sending to
-          #   production or sandbox APNs (string `true` or `false`)
-          # @param [String] api_key [GCM only] This is the "API key" for project from Google
-          #   Developer console for your GCM Service application credential
-          # @param [String] secret The secret
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It can be up to 64 characters long.
+          # @param [String] certificate [APN only] The URL encoded representation of the
+          #   certificate. For example,
+          #   `-----BEGIN CERTIFICATE-----
+          #   MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==
+          #   -----END CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL encoded representation of the
+          #   private key. For example,
+          #   `-----BEGIN RSA PRIVATE KEY-----
+          #   MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.
+          #   -----END RSA PRIVATE KEY-----`
+          # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
+          #   APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
+          # @param [String] api_key [GCM only] The API key for the project that was obtained
+          #   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] Updated CredentialInstance
           def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
             context.update(
@@ -376,8 +387,8 @@ module Twilio
           end
 
           ##
-          # Deletes the CredentialInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the CredentialInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end