twilio-ruby 3.11.5 → 5.71.0

data/lib/twilio-ruby/rest/api/v2010/account/key.rb

@@ -0,0 +1,309 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class KeyList < ListResource
+            ##
+            # Initialize the KeyList
+            # @param [Version] version Version that contains the resource
+            # @param [String] account_sid A 34 character string that uniquely identifies this
+            #   resource.
+            # @return [KeyList] KeyList
+            def initialize(version, account_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {account_sid: account_sid}
+              @uri = "/Accounts/#{@solution[:account_sid]}/Keys.json"
+            end
+
+            ##
+            # Lists KeyInstance 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 KeyInstance 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 KeyInstance 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 KeyInstance 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 KeyInstance
+            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)
+
+              KeyPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of KeyInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of KeyInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              KeyPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Api.V2010.KeyList>'
+            end
+          end
+
+          class KeyPage < Page
+            ##
+            # Initialize the KeyPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [KeyPage] KeyPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of KeyInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [KeyInstance] KeyInstance
+            def get_instance(payload)
+              KeyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Api.V2010.KeyPage>'
+            end
+          end
+
+          class KeyContext < InstanceContext
+            ##
+            # Initialize the KeyContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the Key
+            #   resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the Key
+            #   resource to fetch.
+            # @return [KeyContext] KeyContext
+            def initialize(version, account_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {account_sid: account_sid, sid: sid, }
+              @uri = "/Accounts/#{@solution[:account_sid]}/Keys/#{@solution[:sid]}.json"
+            end
+
+            ##
+            # Fetch the KeyInstance
+            # @return [KeyInstance] Fetched KeyInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              KeyInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
+            end
+
+            ##
+            # Update the KeyInstance
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @return [KeyInstance] Updated KeyInstance
+            def update(friendly_name: :unset)
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              KeyInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
+            end
+
+            ##
+            # Delete the KeyInstance
+            # @return [Boolean] true if delete succeeds, false 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.Api.V2010.KeyContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.KeyContext #{context}>"
+            end
+          end
+
+          class KeyInstance < InstanceResource
+            ##
+            # Initialize the KeyInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] account_sid A 34 character string that uniquely identifies this
+            #   resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the Key
+            #   resource to fetch.
+            # @return [KeyInstance] KeyInstance
+            def initialize(version, payload, account_sid: nil, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'account_sid' => account_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 [KeyContext] KeyContext for this KeyInstance
+            def context
+              unless @instance_context
+                @instance_context = KeyContext.new(@version, @params['account_sid'], @params['sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique string that identifies the resource
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The string that you assigned to describe the resource
+            def friendly_name
+              @properties['friendly_name']
+            end
+
+            ##
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # Fetch the KeyInstance
+            # @return [KeyInstance] Fetched KeyInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the KeyInstance
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @return [KeyInstance] Updated KeyInstance
+            def update(friendly_name: :unset)
+              context.update(friendly_name: friendly_name, )
+            end
+
+            ##
+            # Delete the KeyInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Api.V2010.KeyInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Api.V2010.KeyInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb

@@ -0,0 +1,173 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class MessageContext < InstanceContext
+            class FeedbackList < ListResource
+              ##
+              # Initialize the FeedbackList
+              # @param [Version] version Version that contains the resource
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+              #   MessageFeedback resource.
+              # @param [String] message_sid The SID of the Message resource for which the
+              #   feedback was provided.
+              # @return [FeedbackList] FeedbackList
+              def initialize(version, account_sid: nil, message_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {account_sid: account_sid, message_sid: message_sid}
+                @uri = "/Accounts/#{@solution[:account_sid]}/Messages/#{@solution[:message_sid]}/Feedback.json"
+              end
+
+              ##
+              # Create the FeedbackInstance
+              # @param [feedback.Outcome] outcome Whether the feedback has arrived. Can be:
+              #   `unconfirmed` or `confirmed`. If `provide_feedback`=`true` in {the initial HTTP
+              #   POST}[https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource],
+              #   the initial value of this property is `unconfirmed`. After the message arrives,
+              #   update the value to `confirmed`.
+              # @return [FeedbackInstance] Created FeedbackInstance
+              def create(outcome: :unset)
+                data = Twilio::Values.of({'Outcome' => outcome, })
+
+                payload = @version.create('POST', @uri, data: data)
+
+                FeedbackInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    message_sid: @solution[:message_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Api.V2010.FeedbackList>'
+              end
+            end
+
+            class FeedbackPage < Page
+              ##
+              # Initialize the FeedbackPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [FeedbackPage] FeedbackPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of FeedbackInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [FeedbackInstance] FeedbackInstance
+              def get_instance(payload)
+                FeedbackInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    message_sid: @solution[:message_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Api.V2010.FeedbackPage>'
+              end
+            end
+
+            class FeedbackInstance < InstanceResource
+              ##
+              # Initialize the FeedbackInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+              #   MessageFeedback resource.
+              # @param [String] message_sid The SID of the Message resource for which the
+              #   feedback was provided.
+              # @return [FeedbackInstance] FeedbackInstance
+              def initialize(version, payload, account_sid: nil, message_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'message_sid' => payload['message_sid'],
+                    'outcome' => payload['outcome'],
+                    'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                    'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                    'uri' => payload['uri'],
+                }
+              end
+
+              ##
+              # @return [String] The SID of the Account that created the resource
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The SID of the Message resource for which the feedback was provided
+              def message_sid
+                @properties['message_sid']
+              end
+
+              ##
+              # @return [feedback.Outcome] Whether the feedback has arrived
+              def outcome
+                @properties['outcome']
+              end
+
+              ##
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was created
+              def date_created
+                @properties['date_created']
+              end
+
+              ##
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
+              def date_updated
+                @properties['date_updated']
+              end
+
+              ##
+              # @return [String] The URI of the resource, relative to `https://api.twilio.com`
+              def uri
+                @properties['uri']
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                "<Twilio.Api.V2010.FeedbackInstance>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                "<Twilio.Api.V2010.FeedbackInstance>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end