twilio-ruby 7.10.7 → 7.11.1

data/lib/twilio-ruby/rest/assistants/v1/policy.rb

@@ -1,364 +0,0 @@
-##
-#    This code was generated by
-#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
-#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
-#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
-#
-#    Twilio - Assistants
-#    This is the public Twilio REST API.
-#
-#    NOTE: This class is auto generated by OpenAPI Generator.
-#    https://openapi-generator.tech
-#    Do not edit the class manually.
-#
-
-
-module Twilio
-    module REST
-        class Assistants < AssistantsBase
-            class V1 < Version
-                class PolicyList < ListResource
-                
-                    ##
-                    # Initialize the PolicyList
-                    # @param [Version] version Version that contains the resource
-                    # @return [PolicyList] PolicyList
-                    def initialize(version)
-                        super(version)
-                        
-                        # Path Solution
-                        @solution = {  }
-                        @uri = "/Policies"
-                        
-                    end
-                
-                    ##
-                    # Lists PolicyInstance records from the API as a list.
-                    # Unlike stream(), this operation is eager and will load `limit` records into
-                    # memory before returning.
-                    # @param [String] tool_id The tool ID.
-                    # @param [String] knowledge_id The knowledge ID.
-                    # @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(tool_id: :unset, knowledge_id: :unset, limit: nil, page_size: nil)
-                        self.stream(
-                            tool_id: tool_id,
-                            knowledge_id: knowledge_id,
-                            limit: limit,
-                            page_size: page_size
-                        ).entries
-                    end
-
-                    ##
-                    # Streams Instance records from the API as an Enumerable.
-                    # This operation lazily loads records as efficiently as possible until the limit
-                    # is reached.
-                    # @param [String] tool_id The tool ID.
-                    # @param [String] knowledge_id The knowledge ID.
-                    # @param [Integer] limit Upper limit for the number of records to return. stream()
-                    #    guarantees to never return more than limit.  Default is no limit
-                    # @param [Integer] page_size Number of records to fetch per request, when
-                    #    not set will use the default value of 50 records.  If no page_size is defined
-                    #    but a limit is defined, stream() will attempt to read the limit with the most
-                    #    efficient page size, i.e. min(limit, 1000)
-                    # @return [Enumerable] Enumerable that will yield up to limit results
-                    def stream(tool_id: :unset, knowledge_id: :unset, limit: nil, page_size: nil)
-                        limits = @version.read_limits(limit, page_size)
-
-                        page = self.page(
-                            tool_id: tool_id,
-                            knowledge_id: knowledge_id,
-                            page_size: limits[:page_size], )
-
-                        return [].each if page.nil?
-
-                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
-                        return [].each if result.nil?
-                        result
-                    end
-
-                    ##
-                    # Lists PolicyPageMetadata records from the API as a list.
-                      # @param [String] tool_id The tool ID.
-                      # @param [String] knowledge_id The knowledge ID.
-                    # @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(tool_id: :unset, knowledge_id: :unset, limit: nil, page_size: nil)
-                        limits = @version.read_limits(limit, page_size)
-                        params = Twilio::Values.of({
-                            'ToolId' => tool_id,
-                            'KnowledgeId' => knowledge_id,
-                            
-                            'PageSize' => limits[:page_size],
-                        });
-                        headers = Twilio::Values.of({})
-
-                        response = @version.page('GET', @uri, params: params, headers: headers)
-
-                        PolicyPageMetadata.new(@version, response, @solution, limits[:limit])
-                    end
-
-                    ##
-                    # When passed a block, yields PolicyInstance records from the API.
-                    # This operation lazily loads records as efficiently as possible until the limit
-                    # is reached.
-                    def each
-                        limits = @version.read_limits
-
-                        page = self.page(page_size: limits[:page_size], )
-
-                        return [].each if page.nil?
-
-                        result = @version.stream(page,
-                            limit: limits[:limit],
-                            page_limit: limits[:page_limit])
-                        return [].each if result.nil?
-                        result.each {|x| yield x}
-                    end
-
-                    ##
-                    # Retrieve a single page of PolicyInstance records from the API.
-                    # Request is executed immediately.
-                    # @param [String] tool_id The tool ID.
-                    # @param [String] knowledge_id The knowledge ID.
-                    # @param [String] page_token PageToken provided by the API
-                    # @param [Integer] page_number Page Number, this value is simply for client state
-                    # @param [Integer] page_size Number of records to return, defaults to 50
-                    # @return [Page] Page of PolicyInstance
-                    def page(tool_id: :unset, knowledge_id: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
-                        params = Twilio::Values.of({
-                            'ToolId' => tool_id,
-                            'KnowledgeId' => knowledge_id,
-                            'PageToken' => page_token,
-                            'Page' => page_number,
-                            'PageSize' => page_size,
-                        })
-                        headers = Twilio::Values.of({})
-                        
-                        
-
-                        response = @version.page('GET', @uri, params: params, headers: headers)
-
-                        PolicyPage.new(@version, response, @solution)
-                    end
-
-                    ##
-                    # Retrieve a single page of PolicyInstance records from the API.
-                    # Request is executed immediately.
-                    # @param [String] target_url API-generated URL for the requested results page
-                    # @return [Page] Page of PolicyInstance
-                    def get_page(target_url)
-                        response = @version.domain.request(
-                            'GET',
-                            target_url
-                        )
-                    PolicyPage.new(@version, response, @solution)
-                    end
-                    
-
-
-                    # Provide a user friendly representation
-                    def to_s
-                        '#<Twilio.Assistants.V1.PolicyList>'
-                    end
-                end
-
-                class PolicyPage < Page
-                    ##
-                    # Initialize the PolicyPage
-                    # @param [Version] version Version that contains the resource
-                    # @param [Response] response Response from the API
-                    # @param [Hash] solution Path solution for the resource
-                    # @return [PolicyPage] PolicyPage
-                    def initialize(version, response, solution)
-                        super(version, response)
-                        
-
-                        # Path Solution
-                        @solution = solution
-                    end
-
-                    ##
-                    # Build an instance of PolicyInstance
-                    # @param [Hash] payload Payload response from the API
-                    # @return [PolicyInstance] PolicyInstance
-                    def get_instance(payload)
-                        PolicyInstance.new(@version, payload)
-                    end
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        '<Twilio.Assistants.V1.PolicyPage>'
-                    end
-                end
-
-                class PolicyPageMetadata < PageMetadata
-                    attr_reader :policy_page
-
-                    def initialize(version, response, solution, limit)
-                        super(version, response)
-                        @policy_page = []
-                        @limit = limit
-                        key = get_key(response.body)
-                        records = 0
-                        while( limit != :unset && records < limit )
-                            @policy_page << PolicyListResponse.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
-                        @policy_page.each do |record|
-                          yield record
-                        end
-                    end
-
-                    def to_s
-                      '<Twilio::REST::Assistants::V1PageMetadata>';
-                    end
-                end
-                class PolicyListResponse < InstanceListResource
-
-                    # @param [Array<PolicyInstance>] 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
-                      @policy = data_list.map do |data|
-                        PolicyInstance.new(version, data)
-                      end
-                      @headers = payload.headers
-                      @status_code = payload.status_code
-                    end
-
-                    def policy
-                        @policy
-                    end
-
-                    def headers
-                      @headers
-                    end
-
-                    def status_code
-                      @status_code
-                    end
-                end
-
-                class PolicyInstance < InstanceResource
-                    ##
-                    # Initialize the PolicyInstance
-                    # @param [Version] version Version that contains the resource
-                    # @param [Hash] payload payload that contains response from Twilio
-                    # @param [String] account_sid The SID of the
-                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Policy
-                    #   resource.
-                    # @param [String] sid The SID of the Call resource to fetch.
-                    # @return [PolicyInstance] PolicyInstance
-                    def initialize(version, payload )
-                        super(version)
-                        
-                        
-                        # Marshaled Properties
-                        @properties = { 
-                            'id' => payload['id'],
-                            'name' => payload['name'],
-                            'description' => payload['description'],
-                            'account_sid' => payload['account_sid'],
-                            'user_sid' => payload['user_sid'],
-                            'type' => payload['type'],
-                            'policy_details' => payload['policy_details'],
-                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                        }
-                    end
-
-                    
-                    ##
-                    # @return [String] The Policy ID.
-                    def id
-                        @properties['id']
-                    end
-                    
-                    ##
-                    # @return [String] The name of the policy.
-                    def name
-                        @properties['name']
-                    end
-                    
-                    ##
-                    # @return [String] The description of the policy.
-                    def description
-                        @properties['description']
-                    end
-                    
-                    ##
-                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Policy resource.
-                    def account_sid
-                        @properties['account_sid']
-                    end
-                    
-                    ##
-                    # @return [String] The SID of the User that created the Policy resource.
-                    def user_sid
-                        @properties['user_sid']
-                    end
-                    
-                    ##
-                    # @return [String] The type of the policy.
-                    def type
-                        @properties['type']
-                    end
-                    
-                    ##
-                    # @return [Hash] The details of the policy based on the type.
-                    def policy_details
-                        @properties['policy_details']
-                    end
-                    
-                    ##
-                    # @return [Time] The date and time in GMT when the Policy was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
-                    def date_created
-                        @properties['date_created']
-                    end
-                    
-                    ##
-                    # @return [Time] The date and time in GMT when the Policy was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
-                    def date_updated
-                        @properties['date_updated']
-                    end
-                    
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        "<Twilio.Assistants.V1.PolicyInstance>"
-                    end
-
-                    ##
-                    # Provide a detailed, user friendly representation
-                    def inspect
-                        "<Twilio.Assistants.V1.PolicyInstance>"
-                    end
-                end
-
-            end
-        end
-    end
-end