twilio-ruby 7.9.1 → 7.10.0

data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb

@@ -29,6 +29,7 @@ module Twilio
                     # @return [CredentialList] CredentialList
                     def initialize(version, account_sid: nil, credential_list_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid, credential_list_sid: credential_list_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/SIP/CredentialLists/#{@solution[:credential_list_sid]}/Credentials.json"
@@ -64,6 +65,42 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the CredentialInstanceMetadata
+                    # @param [String] username The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio's challenge of the initial INVITE. It can be up to 32 characters long.
+                    # @param [String] password The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)
+                    # @return [CredentialInstance] Created CredentialInstance
+                    def create_with_metadata(
+                      username: nil, 
+                      password: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Username' => username,
+                            'Password' => password,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        credential_instance = CredentialInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            credential_list_sid: @solution[:credential_list_sid],
+                        )
+                        CredentialInstanceMetadata.new(
+                            @version,
+                            credential_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists CredentialInstance records from the API as a list.
@@ -103,6 +140,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists CredentialPageMetadata 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)
+
+                        CredentialPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields CredentialInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -124,7 +183,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 CredentialInstance
-                    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,
@@ -171,6 +230,7 @@ module Twilio
                     # @return [CredentialContext] CredentialContext
                     def initialize(version, account_sid, credential_list_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, credential_list_sid: credential_list_sid, sid: sid,  }
@@ -187,9 +247,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the CredentialInstanceMetadata
+                    # @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)
+                          credential_instance = CredentialInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          CredentialInstanceMetadata.new(@version, credential_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the CredentialInstance
                     # @return [CredentialInstance] Fetched CredentialInstance
@@ -211,6 +291,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the CredentialInstanceMetadata
+                    # @return [CredentialInstance] Fetched CredentialInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        credential_instance = CredentialInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            credential_list_sid: @solution[:credential_list_sid],
+                            sid: @solution[:sid],
+                        )
+                        CredentialInstanceMetadata.new(
+                            @version,
+                            credential_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the CredentialInstance
                     # @param [String] password The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)
@@ -239,6 +346,40 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the CredentialInstanceMetadata
+                    # @param [String] password The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)
+                    # @return [CredentialInstance] Updated CredentialInstance
+                    def update_with_metadata(
+                      password: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Password' => password,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        credential_instance = CredentialInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            credential_list_sid: @solution[:credential_list_sid],
+                            sid: @solution[:sid],
+                        )
+                        CredentialInstanceMetadata.new(
+                            @version,
+                            credential_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -255,6 +396,53 @@ module Twilio
                     end
                 end
 
+                class CredentialInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new CredentialInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}CredentialInstance] credential_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 [CredentialInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, credential_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @credential_instance = credential_instance
+                    end
+
+                    def credential
+                        @credential_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.CredentialInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class CredentialListResponse < InstanceListResource
+                    # @param [Array<CredentialInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @credential_instance = payload.body[key].map do |data|
+                        CredentialInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def credential_instance
+                          @instance
+                      end
+                  end
+
                 class CredentialPage < Page
                     ##
                     # Initialize the CredentialPage
@@ -264,6 +452,7 @@ module Twilio
                     # @return [CredentialPage] CredentialPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -283,6 +472,66 @@ module Twilio
                         '<Twilio.Api.V2010.CredentialPage>'
                     end
                 end
+
+                class CredentialPageMetadata < PageMetadata
+                    attr_reader :credential_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @credential_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @credential_page << CredentialListResponse.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
+                        @credential_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class CredentialListResponse < InstanceListResource
+
+                    # @param [Array<CredentialInstance>] 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
+                      @credential = data_list.map do |data|
+                        CredentialInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def credential
+                        @credential
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class CredentialInstance < InstanceResource
                     ##
                     # Initialize the CredentialInstance
@@ -296,6 +545,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, credential_list_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -28,6 +28,7 @@ module Twilio
                     # @return [CredentialListList] CredentialListList
                     def initialize(version, account_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/SIP/CredentialLists.json"
@@ -59,6 +60,38 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the CredentialListInstanceMetadata
+                    # @param [String] friendly_name A human readable descriptive text that describes the CredentialList, up to 64 characters long.
+                    # @return [CredentialListInstance] Created CredentialListInstance
+                    def create_with_metadata(
+                      friendly_name: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        credential_list_instance = CredentialListInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                        )
+                        CredentialListInstanceMetadata.new(
+                            @version,
+                            credential_list_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists CredentialListInstance records from the API as a list.
@@ -98,6 +131,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists CredentialListPageMetadata 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)
+
+                        CredentialListPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields CredentialListInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -119,7 +174,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 CredentialListInstance
-                    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,
@@ -165,6 +220,7 @@ module Twilio
                     # @return [CredentialListContext] CredentialListContext
                     def initialize(version, account_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, sid: sid,  }
@@ -182,9 +238,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the CredentialListInstanceMetadata
+                    # @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)
+                          credentialList_instance = CredentialListInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          CredentialListInstanceMetadata.new(@version, credentialList_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the CredentialListInstance
                     # @return [CredentialListInstance] Fetched CredentialListInstance
@@ -205,6 +281,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the CredentialListInstanceMetadata
+                    # @return [CredentialListInstance] Fetched CredentialListInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        credential_list_instance = CredentialListInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        CredentialListInstanceMetadata.new(
+                            @version,
+                            credential_list_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the CredentialListInstance
                     # @param [String] friendly_name A human readable descriptive text for a CredentialList, up to 64 characters long.
@@ -232,6 +334,39 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the CredentialListInstanceMetadata
+                    # @param [String] friendly_name A human readable descriptive text for a CredentialList, up to 64 characters long.
+                    # @return [CredentialListInstance] Updated CredentialListInstance
+                    def update_with_metadata(
+                      friendly_name: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        credential_list_instance = CredentialListInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        CredentialListInstanceMetadata.new(
+                            @version,
+                            credential_list_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the credentials
                     # @return [CredentialList]
@@ -267,6 +402,53 @@ module Twilio
                     end
                 end
 
+                class CredentialListInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new CredentialListInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}CredentialListInstance] credential_list_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 [CredentialListInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, credential_list_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @credential_list_instance = credential_list_instance
+                    end
+
+                    def credential_list
+                        @credential_list_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.CredentialListInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class CredentialListListResponse < InstanceListResource
+                    # @param [Array<CredentialListInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @credential_list_instance = payload.body[key].map do |data|
+                        CredentialListInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def credential_list_instance
+                          @instance
+                      end
+                  end
+
                 class CredentialListPage < Page
                     ##
                     # Initialize the CredentialListPage
@@ -276,6 +458,7 @@ module Twilio
                     # @return [CredentialListPage] CredentialListPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -295,6 +478,66 @@ module Twilio
                         '<Twilio.Api.V2010.CredentialListPage>'
                     end
                 end
+
+                class CredentialListPageMetadata < PageMetadata
+                    attr_reader :credential_list_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @credential_list_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @credential_list_page << CredentialListListResponse.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
+                        @credential_list_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class CredentialListListResponse < InstanceListResource
+
+                    # @param [Array<CredentialListInstance>] 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
+                      @credential_list = data_list.map do |data|
+                        CredentialListInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def credential_list
+                        @credential_list
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class CredentialListInstance < InstanceResource
                     ##
                     # Initialize the CredentialListInstance
@@ -308,6 +551,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],