twilio-ruby 7.9.1 → 7.10.0

data/lib/twilio-ruby/rest/conversations/v1/role.rb

@@ -25,6 +25,7 @@ module Twilio
                     # @return [RoleList] RoleList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Roles"
@@ -61,6 +62,43 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the RoleInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the new resource. It can be up to 64 characters long.
+                    # @param [RoleType] type 
+                    # @param [Array[String]] permission A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type`.
+                    # @return [RoleInstance] Created RoleInstance
+                    def create_with_metadata(
+                      friendly_name: nil, 
+                      type: nil, 
+                      permission: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Type' => type,
+                            'Permission' => Twilio.serialize_list(permission) { |e| e },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        role_instance = RoleInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        RoleInstanceMetadata.new(
+                            @version,
+                            role_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists RoleInstance records from the API as a list.
@@ -100,6 +138,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists RolePageMetadata records from the API as a list.
+                    # @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(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        RolePageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields RoleInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -121,7 +181,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 RoleInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             'Page' => page_number,
@@ -166,6 +226,7 @@ module Twilio
                     # @return [RoleContext] RoleContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -182,9 +243,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the RoleInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          role_instance = RoleInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          RoleInstanceMetadata.new(@version, role_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the RoleInstance
                     # @return [RoleInstance] Fetched RoleInstance
@@ -204,6 +285,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the RoleInstanceMetadata
+                    # @return [RoleInstance] Fetched RoleInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        role_instance = RoleInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        RoleInstanceMetadata.new(
+                            @version,
+                            role_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the RoleInstance
                     # @param [Array[String]] permission A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role's `type`.
@@ -230,6 +336,38 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the RoleInstanceMetadata
+                    # @param [Array[String]] permission A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role's `type`.
+                    # @return [RoleInstance] Updated RoleInstance
+                    def update_with_metadata(
+                      permission: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Permission' => Twilio.serialize_list(permission) { |e| e },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        role_instance = RoleInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        RoleInstanceMetadata.new(
+                            @version,
+                            role_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -246,6 +384,53 @@ module Twilio
                     end
                 end
 
+                class RoleInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new RoleInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}RoleInstance] role_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 [RoleInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, role_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @role_instance = role_instance
+                    end
+
+                    def role
+                        @role_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.RoleInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class RoleListResponse < InstanceListResource
+                    # @param [Array<RoleInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @role_instance = payload.body[key].map do |data|
+                        RoleInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def role_instance
+                          @instance
+                      end
+                  end
+
                 class RolePage < Page
                     ##
                     # Initialize the RolePage
@@ -255,6 +440,7 @@ module Twilio
                     # @return [RolePage] RolePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -274,6 +460,66 @@ module Twilio
                         '<Twilio.Conversations.V1.RolePage>'
                     end
                 end
+
+                class RolePageMetadata < PageMetadata
+                    attr_reader :role_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @role_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @role_page << RoleListResponse.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
+                        @role_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Conversations::V1PageMetadata>';
+                    end
+                end
+                class RoleListResponse < InstanceListResource
+
+                    # @param [Array<RoleInstance>] 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
+                      @role = data_list.map do |data|
+                        RoleInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def role
+                        @role
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class RoleInstance < InstanceResource
                     ##
                     # Initialize the RoleInstance
@@ -287,6 +533,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

data/lib/twilio-ruby/rest/conversations/v1/service/binding.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [BindingList] BindingList
                     def initialize(version, chat_service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { chat_service_sid: chat_service_sid }
                         @uri = "/Services/#{@solution[:chat_service_sid]}/Bindings"
@@ -79,6 +80,34 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists BindingPageMetadata records from the API as a list.
+                      # @param [Array[BindingType]] binding_type The push technology used by the Binding resources to read.  Can be: `apn`, `gcm`, `fcm`, or `twilsock`.  See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.
+                      # @param [Array[String]] identity The identity of a [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource) this binding belongs to. See [access tokens](https://www.twilio.com/docs/conversations/create-tokens) for more details.
+                    # @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(binding_type: :unset, identity: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'BindingType' =>  Twilio.serialize_list(binding_type) { |e| e },
+                            
+                            'Identity' =>  Twilio.serialize_list(identity) { |e| e },
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        BindingPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields BindingInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -102,7 +131,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 BindingInstance
-                    def page(binding_type: :unset, identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(binding_type: :unset, identity: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             
                             'BindingType' =>  Twilio.serialize_list(binding_type) { |e| e },
@@ -152,6 +181,7 @@ module Twilio
                     # @return [BindingContext] BindingContext
                     def initialize(version, chat_service_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { chat_service_sid: chat_service_sid, sid: sid,  }
@@ -168,9 +198,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the BindingInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          binding_instance = BindingInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          BindingInstanceMetadata.new(@version, binding_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the BindingInstance
                     # @return [BindingInstance] Fetched BindingInstance
@@ -191,6 +241,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the BindingInstanceMetadata
+                    # @return [BindingInstance] Fetched BindingInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        binding_instance = BindingInstance.new(
+                            @version,
+                            response.body,
+                            chat_service_sid: @solution[:chat_service_sid],
+                            sid: @solution[:sid],
+                        )
+                        BindingInstanceMetadata.new(
+                            @version,
+                            binding_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -207,6 +283,53 @@ module Twilio
                     end
                 end
 
+                class BindingInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new BindingInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}BindingInstance] binding_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 [BindingInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, binding_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @binding_instance = binding_instance
+                    end
+
+                    def binding
+                        @binding_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.BindingInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class BindingListResponse < InstanceListResource
+                    # @param [Array<BindingInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @binding_instance = payload.body[key].map do |data|
+                        BindingInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def binding_instance
+                          @instance
+                      end
+                  end
+
                 class BindingPage < Page
                     ##
                     # Initialize the BindingPage
@@ -216,6 +339,7 @@ module Twilio
                     # @return [BindingPage] BindingPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -235,6 +359,66 @@ module Twilio
                         '<Twilio.Conversations.V1.BindingPage>'
                     end
                 end
+
+                class BindingPageMetadata < PageMetadata
+                    attr_reader :binding_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @binding_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @binding_page << BindingListResponse.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
+                        @binding_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Conversations::V1PageMetadata>';
+                    end
+                end
+                class BindingListResponse < InstanceListResource
+
+                    # @param [Array<BindingInstance>] 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
+                      @binding = data_list.map do |data|
+                        BindingInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def binding
+                        @binding
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class BindingInstance < InstanceResource
                     ##
                     # Initialize the BindingInstance
@@ -248,6 +432,7 @@ module Twilio
                     def initialize(version, payload , chat_service_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],