twilio-ruby 7.9.1 → 7.10.0

data/lib/twilio-ruby/rest/flex_api/v1/plugin.rb

@@ -25,6 +25,7 @@ module Twilio
                     # @return [PluginList] PluginList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/PluginService/Plugins"
@@ -63,6 +64,45 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the PluginInstanceMetadata
+                    # @param [String] unique_name The Flex Plugin's unique name.
+                    # @param [String] friendly_name The Flex Plugin's friendly name.
+                    # @param [String] description A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long
+                    # @param [String] flex_metadata The Flex-Metadata HTTP request header
+                    # @return [PluginInstance] Created PluginInstance
+                    def create_with_metadata(
+                      unique_name: nil, 
+                      friendly_name: :unset, 
+                      description: :unset, 
+                      flex_metadata: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'UniqueName' => unique_name,
+                            'FriendlyName' => friendly_name,
+                            'Description' => description,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Flex-Metadata' => flex_metadata, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        plugin_instance = PluginInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        PluginInstanceMetadata.new(
+                            @version,
+                            plugin_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists PluginInstance records from the API as a list.
@@ -106,6 +146,30 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists PluginPageMetadata records from the API as a list.
+                      # @param [String] flex_metadata The Flex-Metadata HTTP request header
+                    # @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_with_metadata(flex_metadata: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Flex-Metadata' => flex_metadata,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        PluginPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields PluginInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -128,7 +192,7 @@ module Twilio
                     # @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 PluginInstance
-                    def page(flex_metadata: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(flex_metadata: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Flex-Metadata' => flex_metadata,
                             'PageToken' => page_token,
@@ -174,6 +238,7 @@ module Twilio
                     # @return [PluginContext] PluginContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -204,6 +269,34 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the PluginInstanceMetadata
+                    # @param [String] flex_metadata The Flex-Metadata HTTP request header
+                    # @return [PluginInstance] Fetched PluginInstance
+                    def fetch_with_metadata(
+                      flex_metadata: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Flex-Metadata' => flex_metadata, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        plugin_instance = PluginInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        PluginInstanceMetadata.new(
+                            @version,
+                            plugin_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the PluginInstance
                     # @param [String] friendly_name The Flex Plugin's friendly name.
@@ -235,6 +328,43 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the PluginInstanceMetadata
+                    # @param [String] friendly_name The Flex Plugin's friendly name.
+                    # @param [String] description A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long
+                    # @param [String] flex_metadata The Flex-Metadata HTTP request header
+                    # @return [PluginInstance] Updated PluginInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      description: :unset, 
+                      flex_metadata: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Description' => description,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Flex-Metadata' => flex_metadata, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        plugin_instance = PluginInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        PluginInstanceMetadata.new(
+                            @version,
+                            plugin_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the plugin_versions
                     # @return [PluginVersionsList]
@@ -270,6 +400,53 @@ module Twilio
                     end
                 end
 
+                class PluginInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new PluginInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}PluginInstance] plugin_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [PluginInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, plugin_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @plugin_instance = plugin_instance
+                    end
+
+                    def plugin
+                        @plugin_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.PluginInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class PluginListResponse < InstanceListResource
+                    # @param [Array<PluginInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @plugin_instance = payload.body[key].map do |data|
+                        PluginInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def plugin_instance
+                          @instance
+                      end
+                  end
+
                 class PluginPage < Page
                     ##
                     # Initialize the PluginPage
@@ -279,6 +456,7 @@ module Twilio
                     # @return [PluginPage] PluginPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -298,6 +476,66 @@ module Twilio
                         '<Twilio.FlexApi.V1.PluginPage>'
                     end
                 end
+
+                class PluginPageMetadata < PageMetadata
+                    attr_reader :plugin_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @plugin_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @plugin_page << PluginListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @plugin_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::FlexApi::V1PageMetadata>';
+                    end
+                end
+                class PluginListResponse < InstanceListResource
+
+                    # @param [Array<PluginInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @plugin = data_list.map do |data|
+                        PluginInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def plugin
+                        @plugin
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class PluginInstance < InstanceResource
                     ##
                     # Initialize the PluginInstance
@@ -311,6 +549,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

data/lib/twilio-ruby/rest/flex_api/v1/plugin_archive.rb

@@ -25,6 +25,7 @@ module Twilio
                     # @return [PluginArchiveList] PluginArchiveList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         
@@ -48,6 +49,7 @@ module Twilio
                     # @return [PluginArchiveContext] PluginArchiveContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -77,6 +79,34 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the PluginArchiveInstanceMetadata
+                    # @param [String] flex_metadata The Flex-Metadata HTTP request header
+                    # @return [PluginArchiveInstance] Updated PluginArchiveInstance
+                    def update_with_metadata(
+                      flex_metadata: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Flex-Metadata' => flex_metadata, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, headers: headers)
+                        plugin_archive_instance = PluginArchiveInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        PluginArchiveInstanceMetadata.new(
+                            @version,
+                            plugin_archive_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -93,6 +123,53 @@ module Twilio
                     end
                 end
 
+                class PluginArchiveInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new PluginArchiveInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}PluginArchiveInstance] plugin_archive_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [PluginArchiveInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, plugin_archive_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @plugin_archive_instance = plugin_archive_instance
+                    end
+
+                    def plugin_archive
+                        @plugin_archive_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.PluginArchiveInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class PluginArchiveListResponse < InstanceListResource
+                    # @param [Array<PluginArchiveInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @plugin_archive_instance = payload.body[key].map do |data|
+                        PluginArchiveInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def plugin_archive_instance
+                          @instance
+                      end
+                  end
+
                 class PluginArchivePage < Page
                     ##
                     # Initialize the PluginArchivePage
@@ -102,6 +179,7 @@ module Twilio
                     # @return [PluginArchivePage] PluginArchivePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -121,6 +199,66 @@ module Twilio
                         '<Twilio.FlexApi.V1.PluginArchivePage>'
                     end
                 end
+
+                class PluginArchivePageMetadata < PageMetadata
+                    attr_reader :plugin_archive_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @plugin_archive_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @plugin_archive_page << PluginArchiveListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @plugin_archive_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::FlexApi::V1PageMetadata>';
+                    end
+                end
+                class PluginArchiveListResponse < InstanceListResource
+
+                    # @param [Array<PluginArchiveInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @plugin_archive = data_list.map do |data|
+                        PluginArchiveInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def plugin_archive
+                        @plugin_archive
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class PluginArchiveInstance < InstanceResource
                     ##
                     # Initialize the PluginArchiveInstance
@@ -134,6 +272,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],