twilio-ruby 4.13.0 → 5.6.4

data/lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb

@@ -0,0 +1,301 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class Marketplace < Version
+        class AvailableAddOnContext < 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 AvailableAddOnExtensionList < ListResource
+            ##
+            # Initialize the AvailableAddOnExtensionList
+            # @param [Version] version Version that contains the resource
+            # @param [String] available_add_on_sid The available_add_on_sid
+            # @return [AvailableAddOnExtensionList] AvailableAddOnExtensionList
+            def initialize(version, available_add_on_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {available_add_on_sid: available_add_on_sid}
+              @uri = "/AvailableAddOns/#{@solution[:available_add_on_sid]}/Extensions"
+            end
+
+            ##
+            # Lists AvailableAddOnExtensionInstance 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 AvailableAddOnExtensionInstance 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 AvailableAddOnExtensionInstance 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 AvailableAddOnExtensionInstance 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 AvailableAddOnExtensionInstance
+            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
+              )
+              AvailableAddOnExtensionPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of AvailableAddOnExtensionInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of AvailableAddOnExtensionInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              AvailableAddOnExtensionPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Preview.Marketplace.AvailableAddOnExtensionList>'
+            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 AvailableAddOnExtensionPage < Page
+            ##
+            # Initialize the AvailableAddOnExtensionPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [AvailableAddOnExtensionPage] AvailableAddOnExtensionPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of AvailableAddOnExtensionInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [AvailableAddOnExtensionInstance] AvailableAddOnExtensionInstance
+            def get_instance(payload)
+              AvailableAddOnExtensionInstance.new(
+                  @version,
+                  payload,
+                  available_add_on_sid: @solution[:available_add_on_sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Preview.Marketplace.AvailableAddOnExtensionPage>'
+            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 AvailableAddOnExtensionContext < InstanceContext
+            ##
+            # Initialize the AvailableAddOnExtensionContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] available_add_on_sid The available_add_on_sid
+            # @param [String] sid The Extension Sid that uniquely identifies this resource
+            # @return [AvailableAddOnExtensionContext] AvailableAddOnExtensionContext
+            def initialize(version, available_add_on_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {available_add_on_sid: available_add_on_sid, sid: sid, }
+              @uri = "/AvailableAddOns/#{@solution[:available_add_on_sid]}/Extensions/#{@solution[:sid]}"
+            end
+
+            ##
+            # Fetch a AvailableAddOnExtensionInstance
+            # @return [AvailableAddOnExtensionInstance] Fetched AvailableAddOnExtensionInstance
+            def fetch
+              params = Twilio::Values.of({})
+
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+
+              AvailableAddOnExtensionInstance.new(
+                  @version,
+                  payload,
+                  available_add_on_sid: @solution[:available_add_on_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.Marketplace.AvailableAddOnExtensionContext #{context}>"
+            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 AvailableAddOnExtensionInstance < InstanceResource
+            ##
+            # Initialize the AvailableAddOnExtensionInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] available_add_on_sid The available_add_on_sid
+            # @param [String] sid The Extension Sid that uniquely identifies this resource
+            # @return [AvailableAddOnExtensionInstance] AvailableAddOnExtensionInstance
+            def initialize(version, payload, available_add_on_sid: nil, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'available_add_on_sid' => payload['available_add_on_sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'product_name' => payload['product_name'],
+                  'unique_name' => payload['unique_name'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'available_add_on_sid' => available_add_on_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 [AvailableAddOnExtensionContext] AvailableAddOnExtensionContext for this AvailableAddOnExtensionInstance
+            def context
+              unless @instance_context
+                @instance_context = AvailableAddOnExtensionContext.new(
+                    @version,
+                    @params['available_add_on_sid'],
+                    @params['sid'],
+                )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] A string that uniquely identifies this Extension
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The available_add_on_sid
+            def available_add_on_sid
+              @properties['available_add_on_sid']
+            end
+
+            ##
+            # @return [String] A human-readable description of this Extension
+            def friendly_name
+              @properties['friendly_name']
+            end
+
+            ##
+            # @return [String] A human-readable description of the Extension's Product
+            def product_name
+              @properties['product_name']
+            end
+
+            ##
+            # @return [String] The string that uniquely identifies this Extension
+            def unique_name
+              @properties['unique_name']
+            end
+
+            ##
+            # @return [String] The url
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch a AvailableAddOnExtensionInstance
+            # @return [AvailableAddOnExtensionInstance] Fetched AvailableAddOnExtensionInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Preview.Marketplace.AvailableAddOnExtensionInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Preview.Marketplace.AvailableAddOnExtensionInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb

@@ -0,0 +1,320 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class Marketplace < Version
+        ##
+        # 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 AvailableAddOnList < ListResource
+          ##
+          # Initialize the AvailableAddOnList
+          # @param [Version] version Version that contains the resource
+          # @return [AvailableAddOnList] AvailableAddOnList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/AvailableAddOns"
+          end
+
+          ##
+          # Lists AvailableAddOnInstance 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 AvailableAddOnInstance 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 AvailableAddOnInstance 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 AvailableAddOnInstance 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 AvailableAddOnInstance
+          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
+            )
+            AvailableAddOnPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of AvailableAddOnInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of AvailableAddOnInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            AvailableAddOnPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Preview.Marketplace.AvailableAddOnList>'
+          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 AvailableAddOnPage < Page
+          ##
+          # Initialize the AvailableAddOnPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [AvailableAddOnPage] AvailableAddOnPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of AvailableAddOnInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [AvailableAddOnInstance] AvailableAddOnInstance
+          def get_instance(payload)
+            AvailableAddOnInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Preview.Marketplace.AvailableAddOnPage>'
+          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 AvailableAddOnContext < InstanceContext
+          ##
+          # Initialize the AvailableAddOnContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The Available Add-on Sid that uniquely identifies this
+          #   resource
+          # @return [AvailableAddOnContext] AvailableAddOnContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/AvailableAddOns/#{@solution[:sid]}"
+
+            # Dependents
+            @extensions = nil
+          end
+
+          ##
+          # Fetch a AvailableAddOnInstance
+          # @return [AvailableAddOnInstance] Fetched AvailableAddOnInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            AvailableAddOnInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Access the extensions
+          # @return [AvailableAddOnExtensionList]
+          # @return [AvailableAddOnExtensionContext] if sid was passed.
+          def extensions(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return AvailableAddOnExtensionContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @extensions
+              @extensions = AvailableAddOnExtensionList.new(@version, available_add_on_sid: @solution[:sid], )
+            end
+
+            @extensions
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.Marketplace.AvailableAddOnContext #{context}>"
+          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 AvailableAddOnInstance < InstanceResource
+          ##
+          # Initialize the AvailableAddOnInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The Available Add-on Sid that uniquely identifies this
+          #   resource
+          # @return [AvailableAddOnInstance] AvailableAddOnInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'friendly_name' => payload['friendly_name'],
+                'description' => payload['description'],
+                'pricing_type' => payload['pricing_type'],
+                'configuration_schema' => payload['configuration_schema'],
+                'url' => payload['url'],
+                'links' => payload['links'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'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 [AvailableAddOnContext] AvailableAddOnContext for this AvailableAddOnInstance
+          def context
+            unless @instance_context
+              @instance_context = AvailableAddOnContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] A string that uniquely identifies this Add-on
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] A description of this Add-on
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [String] A short description of the Add-on functionality
+          def description
+            @properties['description']
+          end
+
+          ##
+          # @return [String] The way customers are charged for using this Add-on
+          def pricing_type
+            @properties['pricing_type']
+          end
+
+          ##
+          # @return [Hash] The JSON Schema describing the Add-on's configuration
+          def configuration_schema
+            @properties['configuration_schema']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Fetch a AvailableAddOnInstance
+          # @return [AvailableAddOnInstance] Fetched AvailableAddOnInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Access the extensions
+          # @return [extensions] extensions
+          def extensions
+            context.extensions
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.Marketplace.AvailableAddOnInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.Marketplace.AvailableAddOnInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end