twilio-ruby 7.3.3 → 7.10.1

data/lib/twilio-ruby/rest/frontline_api/v1/user.rb

@@ -25,6 +25,7 @@ module Twilio
                     # @return [UserList] UserList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         
@@ -48,6 +49,7 @@ module Twilio
                     # @return [UserContext] UserContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -62,6 +64,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         UserInstance.new(
                             @version,
@@ -70,6 +76,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the UserInstanceMetadata
+                    # @return [UserInstance] Fetched UserInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        user_instance = UserInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        UserInstanceMetadata.new(
+                            @version,
+                            user_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the UserInstance
                     # @param [String] friendly_name The string that you assigned to describe the User.
@@ -93,6 +124,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         UserInstance.new(
                             @version,
@@ -101,6 +136,47 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the UserInstanceMetadata
+                    # @param [String] friendly_name The string that you assigned to describe the User.
+                    # @param [String] avatar The avatar URL which will be shown in Frontline application.
+                    # @param [StateType] state 
+                    # @param [Boolean] is_available Whether the User is available for new conversations. Set to `false` to prevent User from receiving new inbound conversations if you are using [Pool Routing](https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing).
+                    # @return [UserInstance] Updated UserInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      avatar: :unset, 
+                      state: :unset, 
+                      is_available: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Avatar' => avatar,
+                            'State' => state,
+                            'IsAvailable' => is_available,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        user_instance = UserInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        UserInstanceMetadata.new(
+                            @version,
+                            user_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -117,6 +193,53 @@ module Twilio
                     end
                 end
 
+                class UserInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new UserInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}UserInstance] user_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 [UserInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, user_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @user_instance = user_instance
+                    end
+
+                    def user
+                        @user_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.UserInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class UserListResponse < InstanceListResource
+                    # @param [Array<UserInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @user_instance = payload.body[key].map do |data|
+                        UserInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def user_instance
+                          @instance
+                      end
+                  end
+
                 class UserPage < Page
                     ##
                     # Initialize the UserPage
@@ -126,6 +249,7 @@ module Twilio
                     # @return [UserPage] UserPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -145,6 +269,66 @@ module Twilio
                         '<Twilio.FrontlineApi.V1.UserPage>'
                     end
                 end
+
+                class UserPageMetadata < PageMetadata
+                    attr_reader :user_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @user_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @user_page << UserListResponse.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
+                        @user_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::FrontlineApi::V1PageMetadata>';
+                    end
+                end
+                class UserListResponse < InstanceListResource
+
+                    # @param [Array<UserInstance>] 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
+                      @user = data_list.map do |data|
+                        UserInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def user
+                        @user
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class UserInstance < InstanceResource
                     ##
                     # Initialize the UserInstance
@@ -158,6 +342,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

data/lib/twilio-ruby/rest/iam/v1/api_key.rb

@@ -25,6 +25,7 @@ module Twilio
                     # @return [ApiKeyList] ApiKeyList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         
@@ -48,6 +49,7 @@ module Twilio
                     # @return [ApiKeyContext] ApiKeyContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -62,9 +64,31 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the ApiKeyInstanceMetadata
+                    # @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)
+                          apiKey_instance = ApiKeyInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          ApiKeyInstanceMetadata.new(@version, apiKey_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the ApiKeyInstance
                     # @return [ApiKeyInstance] Fetched ApiKeyInstance
@@ -72,6 +96,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         ApiKeyInstance.new(
                             @version,
@@ -80,6 +108,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the ApiKeyInstanceMetadata
+                    # @return [ApiKeyInstance] Fetched ApiKeyInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        api_key_instance = ApiKeyInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        ApiKeyInstanceMetadata.new(
+                            @version,
+                            api_key_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the ApiKeyInstance
                     # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
@@ -97,6 +150,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         ApiKeyInstance.new(
                             @version,
@@ -105,6 +162,41 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the ApiKeyInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
+                    # @param [Object] policy The \\\\`Policy\\\\` object is a collection that specifies the allowed Twilio permissions for the restricted key. For more information on the permissions available with restricted API keys, refer to the [Twilio documentation](https://www.twilio.com/docs/iam/api-keys/restricted-api-keys#permissions-available-with-restricted-api-keys).
+                    # @return [ApiKeyInstance] Updated ApiKeyInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      policy: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Policy' => Twilio.serialize_object(policy),
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        api_key_instance = ApiKeyInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        ApiKeyInstanceMetadata.new(
+                            @version,
+                            api_key_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -121,6 +213,53 @@ module Twilio
                     end
                 end
 
+                class ApiKeyInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ApiKeyInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ApiKeyInstance] api_key_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 [ApiKeyInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, api_key_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @api_key_instance = api_key_instance
+                    end
+
+                    def api_key
+                        @api_key_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ApiKeyInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ApiKeyListResponse < InstanceListResource
+                    # @param [Array<ApiKeyInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @api_key_instance = payload.body[key].map do |data|
+                        ApiKeyInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def api_key_instance
+                          @instance
+                      end
+                  end
+
                 class ApiKeyPage < Page
                     ##
                     # Initialize the ApiKeyPage
@@ -130,6 +269,7 @@ module Twilio
                     # @return [ApiKeyPage] ApiKeyPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -149,6 +289,66 @@ module Twilio
                         '<Twilio.Iam.V1.ApiKeyPage>'
                     end
                 end
+
+                class ApiKeyPageMetadata < PageMetadata
+                    attr_reader :api_key_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @api_key_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @api_key_page << ApiKeyListResponse.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
+                        @api_key_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Iam::V1PageMetadata>';
+                    end
+                end
+                class ApiKeyListResponse < InstanceListResource
+
+                    # @param [Array<ApiKeyInstance>] 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
+                      @api_key = data_list.map do |data|
+                        ApiKeyInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def api_key
+                        @api_key
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ApiKeyInstance < InstanceResource
                     ##
                     # Initialize the ApiKeyInstance
@@ -162,6 +362,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

data/lib/twilio-ruby/rest/iam/v1/get_api_keys.rb

@@ -25,6 +25,7 @@ module Twilio
                     # @return [GetApiKeysList] GetApiKeysList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Keys"
@@ -73,6 +74,30 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists GetApiKeysPageMetadata records from the API as a list.
+                      # @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Payments resource.
+                    # @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(account_sid: nil, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'AccountSid' => account_sid,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        GetApiKeysPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields GetApiKeysInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -95,15 +120,18 @@ 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 GetApiKeysInstance
-                    def page(account_sid: nil, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(account_sid: nil, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'AccountSid' => account_sid,
                             'PageToken' => page_token,
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         GetApiKeysPage.new(@version, response, @solution)
                     end
@@ -138,6 +166,7 @@ module Twilio
                     # @return [GetApiKeysPage] GetApiKeysPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -157,6 +186,66 @@ module Twilio
                         '<Twilio.Iam.V1.GetApiKeysPage>'
                     end
                 end
+
+                class GetApiKeysPageMetadata < PageMetadata
+                    attr_reader :get_api_keys_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @get_api_keys_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @get_api_keys_page << GetApiKeysListResponse.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
+                        @get_api_keys_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Iam::V1PageMetadata>';
+                    end
+                end
+                class GetApiKeysListResponse < InstanceListResource
+
+                    # @param [Array<GetApiKeysInstance>] 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
+                      @get_api_keys = data_list.map do |data|
+                        GetApiKeysInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def get_api_keys
+                        @get_api_keys
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class GetApiKeysInstance < InstanceResource
                     ##
                     # Initialize the GetApiKeysInstance
@@ -170,12 +259,14 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
                             'friendly_name' => payload['friendly_name'],
                             'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
                             'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                            'flags' => payload['flags'],
                         }
                     end
 
@@ -204,6 +295,12 @@ module Twilio
                         @properties['date_updated']
                     end
                     
+                    ##
+                    # @return [Array<String>] 
+                    def flags
+                        @properties['flags']
+                    end
+                    
                     ##
                     # Provide a user friendly representation
                     def to_s