twilio-ruby 5.74.0 → 7.10.1

data/lib/twilio-ruby/rest/trusthub/v1/policies.rb

@@ -1,262 +1,453 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Trusthub
+#    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.
 #
-# frozen_string_literal: true
+
 
 module Twilio
-  module REST
-    class Trusthub < Domain
-      class V1 < Version
-        class PoliciesList < ListResource
-          ##
-          # Initialize the PoliciesList
-          # @param [Version] version Version that contains the resource
-          # @return [PoliciesList] PoliciesList
-          def initialize(version)
-            super(version)
-
-            # Path Solution
-            @solution = {}
-            @uri = "/Policies"
-          end
-
-          ##
-          # Lists PoliciesInstance records from the API as a list.
-          # Unlike stream(), this operation is eager and will load `limit` records into
-          # memory before returning.
-          # @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(limit: nil, page_size: nil)
-            self.stream(limit: limit, page_size: page_size).entries
-          end
-
-          ##
-          # Streams PoliciesInstance records from the API as an Enumerable.
-          # This operation lazily loads records as efficiently as possible until the limit
-          # is reached.
-          # @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(limit: nil, page_size: nil)
-            limits = @version.read_limits(limit, page_size)
-
-            page = self.page(page_size: limits[:page_size], )
-
-            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
-          end
-
-          ##
-          # When passed a block, yields PoliciesInstance 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], )
-
-            @version.stream(page,
+    module REST
+        class Trusthub < TrusthubBase
+            class V1 < Version
+                class PoliciesList < ListResource
+                
+                    ##
+                    # Initialize the PoliciesList
+                    # @param [Version] version Version that contains the resource
+                    # @return [PoliciesList] PoliciesList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Policies"
+                        
+                    end
+                
+                    ##
+                    # Lists PoliciesInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @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(limit: nil, page_size: nil)
+                        self.stream(
+                            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 [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(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            page_size: limits[:page_size], )
+
+                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                    end
+
+                    ##
+                    # Lists PoliciesPageMetadata 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)
+
+                        PoliciesPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields PoliciesInstance 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], )
+
+                        @version.stream(page,
                             limit: limits[:limit],
                             page_limit: limits[:page_limit]).each {|x| yield x}
-          end
-
-          ##
-          # Retrieve a single page of PoliciesInstance records from the API.
-          # Request is executed immediately.
-          # @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 PoliciesInstance
-          def page(page_token: :unset, page_number: :unset, page_size: :unset)
-            params = Twilio::Values.of({
-                'PageToken' => page_token,
-                'Page' => page_number,
-                'PageSize' => page_size,
-            })
-
-            response = @version.page('GET', @uri, params: params)
-
-            PoliciesPage.new(@version, response, @solution)
-          end
-
-          ##
-          # Retrieve a single page of PoliciesInstance records from the API.
-          # Request is executed immediately.
-          # @param [String] target_url API-generated URL for the requested results page
-          # @return [Page] Page of PoliciesInstance
-          def get_page(target_url)
-            response = @version.domain.request(
-                'GET',
-                target_url
-            )
-            PoliciesPage.new(@version, response, @solution)
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '#<Twilio.Trusthub.V1.PoliciesList>'
-          end
-        end
-
-        class PoliciesPage < Page
-          ##
-          # Initialize the PoliciesPage
-          # @param [Version] version Version that contains the resource
-          # @param [Response] response Response from the API
-          # @param [Hash] solution Path solution for the resource
-          # @return [PoliciesPage] PoliciesPage
-          def initialize(version, response, solution)
-            super(version, response)
-
-            # Path Solution
-            @solution = solution
-          end
-
-          ##
-          # Build an instance of PoliciesInstance
-          # @param [Hash] payload Payload response from the API
-          # @return [PoliciesInstance] PoliciesInstance
-          def get_instance(payload)
-            PoliciesInstance.new(@version, payload, )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '<Twilio.Trusthub.V1.PoliciesPage>'
-          end
-        end
-
-        class PoliciesContext < InstanceContext
-          ##
-          # Initialize the PoliciesContext
-          # @param [Version] version Version that contains the resource
-          # @param [String] sid The unique string that identifies the Policy resource.
-          # @return [PoliciesContext] PoliciesContext
-          def initialize(version, sid)
-            super(version)
-
-            # Path Solution
-            @solution = {sid: sid, }
-            @uri = "/Policies/#{@solution[:sid]}"
-          end
-
-          ##
-          # Fetch the PoliciesInstance
-          # @return [PoliciesInstance] Fetched PoliciesInstance
-          def fetch
-            payload = @version.fetch('GET', @uri)
-
-            PoliciesInstance.new(@version, payload, sid: @solution[:sid], )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Trusthub.V1.PoliciesContext #{context}>"
-          end
-
-          ##
-          # Provide a detailed, user friendly representation
-          def inspect
-            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Trusthub.V1.PoliciesContext #{context}>"
-          end
-        end
+                    end
+
+                    ##
+                    # Retrieve a single page of PoliciesInstance records from the API.
+                    # Request is executed immediately.
+                    # @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 PoliciesInstance
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
+                        params = Twilio::Values.of({
+                            'PageToken' => page_token,
+                            'Page' => page_number,
+                            'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        PoliciesPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of PoliciesInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of PoliciesInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    PoliciesPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Trusthub.V1.PoliciesList>'
+                    end
+                end
+
+
+                class PoliciesContext < InstanceContext
+                    ##
+                    # Initialize the PoliciesContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] sid The unique string that identifies the Policy resource.
+                    # @return [PoliciesContext] PoliciesContext
+                    def initialize(version, sid)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { sid: sid,  }
+                        @uri = "/Policies/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the PoliciesInstance
+                    # @return [PoliciesInstance] Fetched PoliciesInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        PoliciesInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Fetch the PoliciesInstanceMetadata
+                    # @return [PoliciesInstance] Fetched PoliciesInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        policies_instance = PoliciesInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        PoliciesInstanceMetadata.new(
+                            @version,
+                            policies_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Trusthub.V1.PoliciesContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Trusthub.V1.PoliciesContext #{context}>"
+                    end
+                end
+
+                class PoliciesInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new PoliciesInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}PoliciesInstance] policies_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 [PoliciesInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, policies_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @policies_instance = policies_instance
+                    end
+
+                    def policies
+                        @policies_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.PoliciesInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class PoliciesListResponse < InstanceListResource
+                    # @param [Array<PoliciesInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @policies_instance = payload.body[key].map do |data|
+                        PoliciesInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def policies_instance
+                          @instance
+                      end
+                  end
+
+                class PoliciesPage < Page
+                    ##
+                    # Initialize the PoliciesPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [PoliciesPage] PoliciesPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of PoliciesInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [PoliciesInstance] PoliciesInstance
+                    def get_instance(payload)
+                        PoliciesInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Trusthub.V1.PoliciesPage>'
+                    end
+                end
+
+                class PoliciesPageMetadata < PageMetadata
+                    attr_reader :policies_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @policies_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @policies_page << PoliciesListResponse.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
+                        @policies_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Trusthub::V1PageMetadata>';
+                    end
+                end
+                class PoliciesListResponse < InstanceListResource
+
+                    # @param [Array<PoliciesInstance>] 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
+                      @policies = data_list.map do |data|
+                        PoliciesInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def policies
+                        @policies
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class PoliciesInstance < InstanceResource
+                    ##
+                    # Initialize the PoliciesInstance
+                    # @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 Policies
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [PoliciesInstance] PoliciesInstance
+                    def initialize(version, payload , sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'friendly_name' => payload['friendly_name'],
+                            'requirements' => payload['requirements'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'sid' => sid  || @properties['sid']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [PoliciesContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = PoliciesContext.new(@version , @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that identifies the Policy resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] A human-readable description that is assigned to describe the Policy resource. Examples can include Primary Customer profile policy
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [Hash] The SID of an object that holds the policy information
+                    def requirements
+                        @properties['requirements']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the Policy resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the PoliciesInstance
+                    # @return [PoliciesInstance] Fetched PoliciesInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Trusthub.V1.PoliciesInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Trusthub.V1.PoliciesInstance #{values}>"
+                    end
+                end
 
-        class PoliciesInstance < InstanceResource
-          ##
-          # Initialize the PoliciesInstance
-          # @param [Version] version Version that contains the resource
-          # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The unique string that identifies the Policy resource.
-          # @return [PoliciesInstance] PoliciesInstance
-          def initialize(version, payload, sid: nil)
-            super(version)
-
-            # Marshaled Properties
-            @properties = {
-                'sid' => payload['sid'],
-                'friendly_name' => payload['friendly_name'],
-                'requirements' => payload['requirements'],
-                'url' => payload['url'],
-            }
-
-            # Context
-            @instance_context = nil
-            @params = {'sid' => sid || @properties['sid'], }
-          end
-
-          ##
-          # Generate an instance context for the instance, the context is capable of
-          # performing various actions.  All instance actions are proxied to the context
-          # @return [PoliciesContext] PoliciesContext for this PoliciesInstance
-          def context
-            unless @instance_context
-              @instance_context = PoliciesContext.new(@version, @params['sid'], )
             end
-            @instance_context
-          end
-
-          ##
-          # @return [String] The unique string that identifies the Policy resource
-          def sid
-            @properties['sid']
-          end
-
-          ##
-          # @return [String] A human-readable description of the Policy resource
-          def friendly_name
-            @properties['friendly_name']
-          end
-
-          ##
-          # @return [Hash] The sid of a Policy object that dictates requirements
-          def requirements
-            @properties['requirements']
-          end
-
-          ##
-          # @return [String] The absolute URL of the Policy resource
-          def url
-            @properties['url']
-          end
-
-          ##
-          # Fetch the PoliciesInstance
-          # @return [PoliciesInstance] Fetched PoliciesInstance
-          def fetch
-            context.fetch
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Trusthub.V1.PoliciesInstance #{values}>"
-          end
-
-          ##
-          # Provide a detailed, user friendly representation
-          def inspect
-            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Trusthub.V1.PoliciesInstance #{values}>"
-          end
         end
-      end
     end
-  end
-end
+end