## # This code was generated by # ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ # | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ # | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ # # Twilio - Verify # 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 Verify < VerifyBase class V2 < Version class TemplateList < ListResource ## # Initialize the TemplateList # @param [Version] version Version that contains the resource # @return [TemplateList] TemplateList def initialize(version) super(version) # Path Solution @solution = { } @uri = "/Templates" end ## # Lists TemplateInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [String] friendly_name String filter used to query templates with a given friendly name. # @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(friendly_name: :unset, limit: nil, page_size: nil) self.stream( friendly_name: friendly_name, 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] friendly_name String filter used to query templates with a given friendly name. # @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(friendly_name: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( friendly_name: friendly_name, page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) end ## # When passed a block, yields TemplateInstance 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 TemplateInstance records from the API. # Request is executed immediately. # @param [String] friendly_name String filter used to query templates with a given friendly name. # @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 TemplateInstance def page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) TemplatePage.new(@version, response, @solution) end ## # Retrieve a single page of TemplateInstance records from the API. # Request is executed immediately. # @param [String] target_url API-generated URL for the requested results page # @return [Page] Page of TemplateInstance def get_page(target_url) response = @version.domain.request( 'GET', target_url ) TemplatePage.new(@version, response, @solution) end # Provide a user friendly representation def to_s '#' end end class TemplatePage < Page ## # Initialize the TemplatePage # @param [Version] version Version that contains the resource # @param [Response] response Response from the API # @param [Hash] solution Path solution for the resource # @return [TemplatePage] TemplatePage def initialize(version, response, solution) super(version, response) # Path Solution @solution = solution end ## # Build an instance of TemplateInstance # @param [Hash] payload Payload response from the API # @return [TemplateInstance] TemplateInstance def get_instance(payload) TemplateInstance.new(@version, payload) end ## # Provide a user friendly representation def to_s '' end end class TemplateInstance < InstanceResource ## # Initialize the TemplateInstance # @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 Template # resource. # @param [String] sid The SID of the Call resource to fetch. # @return [TemplateInstance] TemplateInstance def initialize(version, payload ) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'friendly_name' => payload['friendly_name'], 'channels' => payload['channels'], 'translations' => payload['translations'], } end ## # @return [String] A 34 character string that uniquely identifies a Verification Template. def sid @properties['sid'] end ## # @return [String] The unique SID identifier of the Account. def account_sid @properties['account_sid'] end ## # @return [String] A descriptive string that you create to describe a Template. It can be up to 32 characters long. def friendly_name @properties['friendly_name'] end ## # @return [Array] A list of channels that support the Template. Can include: sms, voice. def channels @properties['channels'] end ## # @return [Hash] An object that contains the different translations of the template. Every translation is identified by the language short name and contains its respective information as the approval status, text and created/modified date. def translations @properties['translations'] end ## # Provide a user friendly representation def to_s "" end ## # Provide a detailed, user friendly representation def inspect "" end end end end end end